Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Opened 15 years ago

Last modified 12 years ago

#8 new enhancement

doxygen tags in src/

Reported by: bensch Owned by: nobody
Priority: minor Milestone: Old Orxonox tickets orx-v0
Component: Doxygen Version:
Keywords: Cc:
Referenced By: References:

Description

Everything needs to be documented. And writing a good documentation is not easy, and takes a lot of time, but helps everyone in understanding, what we are doing. Thats the reason, why we should comment our code in the following standardized manner:

  • general
    • todo's: make tags with \todo when something is bad implemented, or something is missing
  • h-file
    • file itself: make a comment about all the h-files (this has mainly been done)
    • classes: write a short comment above the classes with ! comment
    • structs: same as classes
    • variables: write a short comment about the variable (at the end of the line insert: !< cool variable because…)
  • cc-files
    • member-functions: write as much information about what the Function does and if possible about the algorithm behind it. use / \brief comment */
    • return values: all the return values have to be commented with \returns what it returns
    • parameters: every parameter has to be commented with \param paramName comment

to test your comments, run make in the orxonox directory.
visit code-file and header-file to see how it works.

Change History (4)

comment:1 Changed 14 years ago by bensch

  • Milestone changed from feature-taks to 0.3.0-pre-alpha

comment:2 Changed 14 years ago by bensch

  • Milestone changed from 0.3.0-pre-alpha to 0.3.1-pre-alpha

most of the stuff done, world_entities and story entities remain until after the initialisation of the ColisionDetection and the PhysicsEngine

comment:3 Changed 14 years ago by patrick

  • Milestone changed from 0.3.9 to future-tasks

comment:4 Changed 12 years ago by bknecht

  • Milestone changed from Features to Old Orxonox tickets

Milestone Features deleted

Note: See TracTickets for help on using tickets.