Code documentation convention

A file/module description needs to be added below the copyright notice just above the __author__ line:

## @file
# File/module description for Doxigen documentation
 
__author__  = NameGoesHere
__version__ = 0.0

Functions/methods need to be documented inside ””” and ””” like this:

def func():
   """Documentation for a function.
    More details.
    """
    pass

Also for Classes:

class PyClass:
    """Documentation for a class.
    More details.
    """
 
    def __init__(self):
        """The constructor."""
        self._memVar = 0;
 
    def PyMethod(self):
        """Documentation for a method."""
        pass

Maintaining a TODO list in the documentation

In order to generate a proper TODO list in our code reference you can add a @todo tag to a paragraph:

    ## @todo Documentation for something that needs to be done
    Needs.to.be.done.code.fragment


 
 
customize/doxygen_rules.txt · Last modified: 2011/03/27 13:39 by courgette
ODT Export
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki