Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3955 in orxonox.OLD for orxonox/trunk


Ignore:
Timestamp:
Apr 25, 2005, 11:37:47 AM (20 years ago)
Author:
bensch
Message:

orxonox/trunk: better proto-class-files

Location:
orxonox/trunk/src/proto
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/proto/proto_class.cc

    r3655 r3955  
    1 
    2 
    31/*
    42   orxonox - the future of 3D-vertical-scrollers
    … …  
    1614*/
    1715
    18 #define DEBUG_SPECIAL_MODULE DEBUG_MODULE_WORLD_ENTITY
     16//#define DEBUG_SPECIAL_MODULE DEBUG_MODULE_
    1917
    2018#include "proto_class.h"
    21 
    22 #include "stdincl.h" // maybe
    2319
    2420using namespace std;
    … …  
    4339  // delete what has to be deleted here
    4440}
    45 
    46 /**
    47    \brief nonsense - delete this method
    48    \param realy nothing to give
    49    \returns true or false - probably nothing?
    50 
    51    this is just to show the doxygen abilities (this for example is an extension for a long comment)
    52 */
    53 bool ProtoClass::doNonSense (int nothing) {}

  • orxonox/trunk/src/proto/proto_class.h

    r3655 r3955  
    11/*!
    22    \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.
     3    \brief Definition of ...
    54
    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.
    85*/
    96
    … …  
    118#define _PROTO_CLASS_H
    129
    13 #include "what realy has to be included"
    1410#include "base_object.h"
    1511
    16 // FORWARD DEFINITION \\
    17 class someClassWeNeed;
     12// FORWARD DEFINITION
    1813
    1914
    20 /*class Test;*/ /* forward definition of class Test (without including it here!)*/
    2115
    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 */
     16//! A class for ...
    2617class ProtoClass : public BaseObject {
    2718
    … …  
    3021  virtual ~ProtoClass();
    3122
    32   bool doNonSense (int nothing);
    3323
    3424 private:
    35   int nonSense;  //!< doxygen tag here like this for all the variables - delete this variable if you use this
    3625
    3726};

  • orxonox/trunk/src/proto/proto_singleton.h

    r3655 r3955  
    11/*!
    22    \file proto_singleton.h
    3     \brief Definition of the proto class template, used quickly start work
     3    \brief Definition of the ... singleton Class
    44   
    5     a simple file to copy and create a singleton-class from
    65*/
    76
    … …  
    1110#include "base_object.h"
    1211
    13 // FORWARD DEFINITION \\
     12// FORWARD DEFINITION
    1413
    1514//! A default singleton class.
Note: See TracChangeset for help on using the changeset viewer.