Doxygen

Links

• https://doxygen.nl/manual
• https://doxygen.nl/manual/commands.html

Installation

apt install doxygen doxygen-gui

Konfiguration

cd /my/project
doxywizard

Beispiel

/**
 * @mainpage
 * <h1>Objectives</h1>
 * <ul><li>The package polygeo offers classes for processing geometry problems with points, rectangles and polygons.
 * </li>
 * <li>There is the possibility to draw geometric objects as SVG images in a HTML file.</li>
 * </ul>
 * @file main.cpp
 * Contains the main program.
 */
/**
 * Manages a 2 dimensional point.
 */
class Point2D {
  /**
   * Constructor.
   * @param x the x coordinate (left to right)
   * @param y the y coordinate (down to up)
   */
  Point2D(double x, double y);
}