Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 9406 in orxonox.OLD for trunk/CODING-STANDARDS


Ignore:
Timestamp:
Jul 24, 2006, 11:09:47 AM (18 years ago)
Author:
bensch
Message:

orxonox/trunk: merged the proxy back

merged with commandsvn merge -r9346:HEAD https://svn.orxonox.net/orxonox/branches/proxy .

no conflicts

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/CODING-STANDARDS

    r3183 r9406  
    2222     you are just bugfixing or extending write it under co-programmer.
    2323
    24   c) Every element of the must be documented with doxygen-tags.
     24  c) Every element of the code must be documented with doxygen-tags (see 1.2).
    2525
    26261.2.Doxygen Tags:
     
    2929most of the time they extend the /* or // with a second star or a !
    3030
    31   a) h-files: 
     31  a) h-files:
    3232   1) every h-file you want to be documented you have to tag. (tag looks like /*! \file somefile */ )
    3333   2) every class has to be Documented. ( //! what it does)
     
    3838
    3939  c) look out for this: Doxygen parses preprocessor arguments,
    40      so if some comments is excluded by a #ifdef, #endif 
     40     so if some comments is excluded by a #ifdef, #endif
    4141     doxygen will not parse it. And ther will be nothing in the docu.
    4242
     
    8080-----------
    8181/*!
    82   \file someclass.h
    83   \brief Some short description of the someclass
    84   \todo maybe there remains something to do in this entire file
    85 
    86   Here comes a longer description
    87   this can also be longer than one line
    88 */
     82 * @file someclass.h
     83 * @brief Some short description of the someclass
     84 * @todo maybe there remains something to do in this entire file
     85 *
     86 * Here comes a longer description
     87 * this can also be longer than one line
     88 */
    8989
    9090#ifndef _SOMECLASS_H
    9191#define _SOMECLASS_H
    9292
    93 #include <many_headers>
    94 #include "stdincl.h"
     93#include "project_headers"
     94#include <many_external_headers>
    9595
    9696//! short description of the class
    9797/**
    98   \todo what remains to be done here
    99 
    100    longer description
    101 */
     98 * @todo what remains to be done here
     99 *
     100 * longer description
     101 */
    102102class SomeClass
    103103{
    104   private:
    105    int usefull_variable;
    106    int cool_variable; //!< this variable is cool, because...
     104  public: /* functions */
     105   SomeClass();
     106   ~SomeClass();
    107107
    108   protected:
    109     char* someOtherMember;
     108   int mightyFunction(const std::string& name, int value);
    110109
    111   public:
    112    SomeClass (void);
    113    ~SomeClass (void);
    114    
    115    int mightyFunction (char* name, int value);
    116 //....
     110  private: /* functions */
     111   void recompileInternalState();
     112
     113  protected: /* variables */
     114    std::string someOtherMember; //!< some member, that can be touched by derived classes.
     115
     116  private: /* variables */
     117   int usefullVariable;    //!< Usefull because
     118   int coolVariable;       //!< this variable is cool, because...
     119
     120
    117121};
    118122
     
    128132------------
    129133
    130 /* 
     134/*
    131135   orxonox - the future of 3D-vertical-scrollers
    132136
     
    139143
    140144   ### File Specific:
    141    main-programmer: The Name of Myself
     145   main-programmer: The Name of the author
    142146   co-programmer: ...
    143147*/
     
    147151
    148152/**
    149    \brief <a brief description>
    150    \todo I think you get it.
    151 
    152    <more description>
    153 */
     153 * @brief <a brief description>
     154 * @todo I think you get it.
     155 *
     156 * <more description>
     157 */
    154158SomeClass::SomeClass (void)
    155159{
     
    158162
    159163/**
    160    \brief <a brief description>
    161    \todo if something is not destructed it will be here
    162 
    163    <more description>
     164 * @brief <a brief description>
     165 * @todo if something is not destructed it will be here
     166 *
     167 * <more description>
    164168*/
    165169~SomeClass::~SomeClass (void)
     
    169173
    170174/**
    171    \brief <a brief description>
    172    \param name <what is this parameter for>
    173    \param valuse <what for...>
    174    \returns <what it returns>
    175 
    176    <more description>
    177 */
    178 int SomeClass::mightyFuncion (char* name, int value)
     175 * @brief <a brief description>
     176 * @param name <what is this parameter for>
     177 * @param valuse <what for...>
     178 * @returns <what it returns>
     179 *
     180 *  <more description>
     181 */
     182int SomeClass::mightyFuncion (const std::string& name, int value)
    179183{
    180184  this->coolVariable = value;
     
    182186}
    183187
    184 // ...
     188// ... i think you get it :)
Note: See TracChangeset for help on using the changeset viewer.