cpp:doxygen
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| cpp:doxygen [2017/01/14 13:20] – rlunaro | cpp:doxygen [2022/12/02 21:02] (current) – external edit 127.0.0.1 | ||
|---|---|---|---|
| Line 104: | Line 104: | ||
| {{ : | {{ : | ||
| - | What are the results. This | + | What are the results. |
| - | ===== Advanced: custom headers and footers ===== | + | |
| + | This comments: | ||
| + | |||
| + | <code c++> | ||
| + | /** | ||
| + | * Brief explanation of the class Square. | ||
| + | * | ||
| + | * A more long, detailed explanation of the Square | ||
| + | * class, that represents the squares in the classs. | ||
| + | * | ||
| + | */ | ||
| + | class Square: public Figure { | ||
| + | public: | ||
| + | Square(); | ||
| + | ~Square(); | ||
| + | }; | ||
| + | </ | ||
| + | |||
| + | Generate this in the docummentation: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | And this: | ||
| + | |||
| + | <code c++> | ||
| + | /** | ||
| + | * | ||
| + | * This is the explanation of the square constructor. | ||
| + | * | ||
| + | */ | ||
| + | Square:: | ||
| + | // TODO Auto-generated constructor stub | ||
| + | |||
| + | } | ||
| + | </ | ||
| + | |||
| + | Generates this: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | The comments on public properties: | ||
| + | |||
| + | <code c++> | ||
| + | class Square: public Figure { | ||
| + | double side; /*!< comment on a private value */ | ||
| + | public: | ||
| + | double something; /*!< comment on a public property | ||
| + | </ | ||
| + | |||
| + | Yields this: | ||
| + | |||
| + | {{: | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
cpp/doxygen.1484400020.txt.gz · Last modified: 2022/12/02 21:02 (external edit)
