Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3245 in orxonox.OLD for orxonox/trunk


Ignore:
Timestamp:
Dec 22, 2004, 12:14:35 AM (20 years ago)
Author:
patrick
Message:

orxonox/trunk: enhanced protoclass with the right includes and doxygen examples

Location:
orxonox/trunk/src
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/proto_class.cc

    r1956 r3245  
    2323
    2424
     25/**
     26   \brief standard constructor
    2527
     28   \todo this constructor is not jet implemented - do it
     29*/
    2630ProtoClass::ProtoClass () {}
    2731
    2832
     33/**
     34   \brief standard deconstructor
    2935
     36   \todo this deconstructor is not jet implemented - do it
     37*/
    3038ProtoClass::~ProtoClass () {}
    3139
    3240
     41/**
     42   \brief nonsense - delete this method
     43   \param realy nothing to give
     44   \returns true or false - probably nothing?
     45
     46   this is just to show the doxygen abilities
     47*/
     48bool ProtoClass::doNonSense (int nothing) {}

  • orxonox/trunk/src/proto_class.h

    r3224 r3245  
     1/*!
     2    \file world_entity.h
     3    \brief Definition of the basic WorldEntity
     4*/
     5
    16
    27#ifndef _PROTO_CLASS_H
    38#define _PROTO_CLASS_H
    49
    5 #include "data_tank.h"
     10#include "stdincl.h"
    611
     12/*class Test;*/ /* forward definition of class Test (without including it here!)*/
    713
    814class ProtoClass {
    … …  
    1218  ~ProtoClass ();
    1319
     20  bool doNonSense (int nothing);
     21
     22 private:
     23  int nonSense;  //! doxygen tag here like this - delete this variable if you use this
     24
    1425};
    1526

  • orxonox/trunk/src/world_entity.cc

    r3229 r3245  
    4242
    4343/**
    44         \brief standard destructor
     44   \brief standard destructor
    4545*/
    4646WorldEntity::~WorldEntity ()
Note: See TracChangeset for help on using the changeset viewer.