User Tools

Site Tools


cpp:doxygen

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
cpp:doxygen [2017/01/14 14:20] rlunarocpp:doxygen [2022/12/02 22:02] (current) – external edit 127.0.0.1
Line 104: Line 104:
 {{ :cpp:02.png?600 |}} {{ :cpp:02.png?600 |}}
  
-What are the results. This  +What are the results.  
-===== Advancedcustom 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 Squarepublic Figure { 
 +public: 
 + Square(); 
 + ~Square(); 
 +}; 
 +</code> 
 + 
 +Generate this in the docummentation:  
 + 
 +{{:cpp:04.png|}} 
 + 
 +And this:  
 + 
 +<code c++> 
 +/** 
 + * 
 + * This is the explanation of the square constructor. 
 + * 
 + */ 
 +Square::Square() { 
 + // TODO Auto-generated constructor stub 
 + 
 +
 +</code> 
 + 
 +Generates this: 
 + 
 +{{:cpp:05.png|}} 
 + 
 +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  */ 
 +</code> 
 + 
 +Yields this: 
 + 
 +{{:cpp:06.png|}} 
 + 
 + 
 + 
 + 
 + 
  
cpp/doxygen.1484400020.txt.gz · Last modified: 2022/12/02 22:02 (external edit)