Differences

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

--- cpp:doxygen [2017/01/14 14:20] – rlunaro
+++ cpp:doxygen [2017/01/14 16:44] – rlunaro
@@ Line 104: / Line 104: @@
 {{ :cpp:02.png?600 |}}
-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();
+};
+</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|}}