Changeset 3399 in orxonox.OLD for orxonox/branches/nico/src/proto_class.h

Timestamp:

Feb 6, 2005, 11:27:25 PM (20 years ago)

Author:

bensch

Message:

orxonox/branches/nico: merged trunk into branches/nico
merged with command:
svn merge ../trunk/ nico/ -r 3238:HEAD
resolved conflict in favor of branches/nico.

Location:

orxonox/branches/nico

Files:

• . (modified) (1 prop)
• src/proto_class.h (modified) (2 diffs)

orxonox/branches/nico/src/proto_class.h

@@ +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.
+
+    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
 #define _PROTO_CLASS_H
 
-#include "data_tank.h"
+#include "stdincl.h"
 
+/*class Test;*/ /* forward definition of class Test (without including it here!)*/
 
-class ProtoClass {
+//! A default class that aids you to start creating a new class
+/**
+   here can be some longer description of this class
+*/
+class ProtoClass : public BaseObject {
 
  public:
@@ -12 +25 @@
   ~ProtoClass ();
 
+  bool doNonSense (int nothing);
+
+ private:
+  int nonSense;  //!< doxygen tag here like this for all the variables - delete this variable if you use this
+
 };