[nsgoetz]

doxygen is tool to programmatically generate documentation from properly formatted comments. If you use python, it is very similar to pydoc. We never actually used the generated documentation but basically used the format as a style guide. For functions it looks like:

  /** @brief Prints character ch with the specified color
   *         at position (row, col).
   *
   *  If any argument is invalid, the function has no effect.
   *
   *  @param row The row in which to display the character.
   *  @param col The column in which to display the character.
   *  @param ch The character to display.
   *  @param color The color to use to display the character.
   *  @return Void.
   */
  void draw_char(int row, int col, int ch, int color);

Here is the class's guide to doxygen https://www.cs.cmu.edu/~410/doc/doxygen.html