Changeset 3955 in orxonox.OLD for orxonox/trunk/src/proto/proto_class.h

Timestamp:

Apr 25, 2005, 11:37:47 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: better proto-class-files

File:

• orxonox/trunk/src/proto/proto_class.h (modified) (3 diffs)

orxonox/trunk/src/proto/proto_class.h

@@ -1 +1 @@
 /*! 
     \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.
+    \brief Definition of ...
 
-    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.
 */
 
@@ -11 +8 @@
 #define _PROTO_CLASS_H
 
-#include "what realy has to be included"
 #include "base_object.h"
 
-// FORWARD DEFINITION \\
-class someClassWeNeed;
+// FORWARD DEFINITION
 
 
-/*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
-*/
+//! A class for ...
 class ProtoClass : public BaseObject {
 
@@ -30 +21 @@
   virtual ~ProtoClass();
 
-  bool doNonSense (int nothing);
 
  private:
-  int nonSense;  //!< doxygen tag here like this for all the variables - delete this variable if you use this
 
 };