[prev] [index] [next]

Documentation Generators (cont)

Doxygen example:

/**
 * The time class represents a moment of time.
 * \author John Doe
 */
class Time
{
  /**
   * Constructor that sets the time to a given value.
   * \param timemillis is a number of milliseconds passed since Jan 1. 1970
   */
  Time(int timemillis) { ...  }

  /**
   * Get the current time.
   * \return A time object set to the current time.
   */
  static Time now() { ...  }
};