Changeset 3329 in orxonox.OLD for orxonox/trunk

Timestamp:

Jan 4, 2005, 2:22:59 AM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: modified Protoclass to doxygen-standards

Location:

orxonox/trunk/src

Files:

• proto_class.cc (modified) (3 diffs)
• proto_class.h (modified) (3 diffs)

orxonox/trunk/src/proto_class.cc

@@ -25 +25 @@
 /**
    \brief standard constructor
-
    \todo this constructor is not jet implemented - do it
 */
@@ -33 +32 @@
 /**
    \brief standard deconstructor
+   \todo this deconstructor is not jet implemented - do it
 
-   \todo this deconstructor is not jet implemented - do it
 */
 ProtoClass::~ProtoClass () {}
@@ -44 +43 @@
    \returns true or false - probably nothing?
 
-   this is just to show the doxygen abilities
+   this is just to show the doxygen abilities (this for example is an extension for a long comment)
 */
 bool ProtoClass::doNonSense (int nothing) {}

orxonox/trunk/src/proto_class.h

@@ -2 +2 @@
     \file proto_class.h
     \brief Definition of the proto class template, used quickly start work
+    \todo Example: this shows how to use simply add a Marker that here has to be done something.
+
+    The Protoclass exists, to help you quikly getting the run for how to develop in orxonox.
+    It is an example for the CODING-CONVENTION, and a starting-point for every class.
 */
-
 
 #ifndef _PROTO_CLASS_H
@@ -12 +15 @@
 /*class Test;*/ /* forward definition of class Test (without including it here!)*/
 
+//! A default class that aids you to start creating a new class
+/**
+   here can be some longer description of this class
+*/
 class ProtoClass {
 
@@ -21 +28 @@
 
  private:
-  int nonSense;  //! doxygen tag here like this - delete this variable if you use this
+  int nonSense;  //!< doxygen tag here like this for all the variables - delete this variable if you use this
 
 };