Differences

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

--- cpp:doxygen [2017/01/13 22:56] – rlunaro
+++ cpp:doxygen [2022/12/02 21:02] (current) – external edit 127.0.0.1
@@ Line 36: / Line 36: @@
 PROJECT_BRIEF = "this is called PROJECT_BRIEF tag"
-PROJECT_LOGO = "images/hello.gif"
+PROJECT_LOGO = "logo.png"
 # Errors, warnings
@@ Line 45: / Line 45: @@
 # navigation and behaviour
 OUTPUT_DIRECTORY = "doc"
-FILE_PATTERNS = "*.cpp, *.h"
+INPUT= .
+FILE_PATTERNS = *.cpp *.h
 RECURSIVE = yes
 EXCLUDE = "doc/"
@@ Line 54: / Line 55: @@
 HTML_OUTPUT = html
-OUTPUT_LANGUAGE = "English" ## Spanish
+OUTPUT_LANGUAGE = English ## Spanish
 BRIEF_MEMBER_DESC = yes
@@ Line 96: / Line 97: @@
 {{ :cpp:01.png?600 |}}
+===== Second round: Generating documentation =====
+For generating documentation, I've created three classes into my pet project:
+{{ :cpp:02.png?600 |}}
+What are the results.
+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();
+};
+</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|}}