I’ve been creating automatic documentation for the Entertainer project using Doxygen.
As you may know, Entertainer is written in python, so what follows is a short guide to commenting python code in a format that Doxygen will pick up.

Say you wrote the following:

class Demo:
  def theDemoTest(self, testParameter):
    #do something here
    return 0

You can comment this in Doxygen format in the following way:

class Demo:
"""
This is a description of the Demo class
@author Joshua Scotton
@version 0.1
"""
  def theDemoTest(self, testParameter):
  """
  This is the very, very, very, very, very, very, very, very, very, very long description of theDemoTest!
  @brief This is where you can put a brief description
  @see Demo
  @param testParameter String: Input Parameter is a string
  @return int Returns a 0 if successful
  """
    #do something here
    return 0

Quick Tag List
@author
@brief
@bug
@code and @endcode
@date
@file
@package
@param
@return
@see
@todo
@version
@warning

This entry was posted on Wednesday, February 27th, 2008 at 9:24 pm and is filed under IT and Linux. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.