source: orxonox.OLD/orxonox/trunk/src/proto/proto_class.h @ 3755

/*! 
    \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 "what realy has to be included"
#include "base_object.h"

// FORWARD DEFINITION \\
class someClassWeNeed;


/*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 : public BaseObject {

 public:
  ProtoClass();
  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

};

#endif /* _PROTO_CLASS_H */