Doxygen: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
(Die Seite wurde neu angelegt: „= Links = * https://doxygen.nl/manual = Installation = <syntaxhighlight lang="bash"> apt install doxygen doxygen-gui </syntaxhighlight> = Konfiguration = <sy…“) |
|||
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
= Links = | = Links = | ||
* https://doxygen.nl/manual | * https://doxygen.nl/manual | ||
* https://doxygen.nl/manual/commands.html | |||
= Installation = | = Installation = | ||
| Zeile 27: | Zeile 28: | ||
*/ | */ | ||
/** | /** | ||
* Manages a | * Manages a vertical/horizontal rectangle. | ||
*/ | */ | ||
class | class Rectangle{ | ||
/** | |||
* Calculates the the smallest vertical/horizontal rectangle containing all points of the given shapes. | |||
* | |||
* @param shapes An array of <em>Shape</em> instances. | |||
* @param size If lower or equal 0: the array shapes must end with a null entry.<br> | |||
* Otherwise: the number of entries in <em>shapes</em> | |||
} | * @param[out] result The result is stored here. | ||
* @return The parameter <em>shapes</em> (for chaining). | |||
*/ | |||
static Rectangle& | |||
combineOutlines (Shape **shapes, size_t size, Rectangle &result); | |||
}; | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Aktuelle Version vom 6. Dezember 2022, 19:03 Uhr
Links[Bearbeiten]
Installation[Bearbeiten]
apt install doxygen doxygen-gui
Konfiguration[Bearbeiten]
cd /my/project
doxywizard
Beispiel[Bearbeiten]
/**
* @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 vertical/horizontal rectangle.
*/
class Rectangle{
/**
* Calculates the the smallest vertical/horizontal rectangle containing all points of the given shapes.
*
* @param shapes An array of <em>Shape</em> instances.
* @param size If lower or equal 0: the array shapes must end with a null entry.<br>
* Otherwise: the number of entries in <em>shapes</em>
* @param[out] result The result is stored here.
* @return The parameter <em>shapes</em> (for chaining).
*/
static Rectangle&
combineOutlines (Shape **shapes, size_t size, Rectangle &result);
};