Last change
on this file since 3954 was
3954,
checked in by patrick, 19 years ago
|
orxonox/physics: just created the files from the proto classes. have to clean up my flat, didn't have time to code yet
|
File size:
1.0 KB
|
Rev | Line | |
---|
[3954] | 1 | /*! |
---|
| 2 | \file proto_class.h |
---|
| 3 | \brief Definition of the proto class template, used quickly start work |
---|
| 4 | \todo Example: this shows how to use simply add a Marker that here has to be done something. |
---|
| 5 | |
---|
| 6 | The Protoclass exists, to help you quikly getting the run for how to develop in orxonox. |
---|
| 7 | It is an example for the CODING-CONVENTION, and a starting-point for every class. |
---|
| 8 | */ |
---|
| 9 | |
---|
| 10 | #ifndef _PROTO_CLASS_H |
---|
| 11 | #define _PROTO_CLASS_H |
---|
| 12 | |
---|
| 13 | #include "what realy has to be included" |
---|
| 14 | #include "base_object.h" |
---|
| 15 | |
---|
| 16 | // FORWARD DEFINITION \\ |
---|
| 17 | class someClassWeNeed; |
---|
| 18 | |
---|
| 19 | |
---|
| 20 | /*class Test;*/ /* forward definition of class Test (without including it here!)*/ |
---|
| 21 | |
---|
| 22 | //! A default class that aids you to start creating a new class |
---|
| 23 | /** |
---|
| 24 | here can be some longer description of this class |
---|
| 25 | */ |
---|
| 26 | class ProtoClass : public BaseObject { |
---|
| 27 | |
---|
| 28 | public: |
---|
| 29 | ProtoClass(); |
---|
| 30 | virtual ~ProtoClass(); |
---|
| 31 | |
---|
| 32 | bool doNonSense (int nothing); |
---|
| 33 | |
---|
| 34 | private: |
---|
| 35 | int nonSense; //!< doxygen tag here like this for all the variables - delete this variable if you use this |
---|
| 36 | |
---|
| 37 | }; |
---|
| 38 | |
---|
| 39 | #endif /* _PROTO_CLASS_H */ |
---|
Note: See
TracBrowser
for help on using the repository browser.