Changes between Version 22 and Version 23 of code/C++_styleguide

Timestamp:

Sep 20, 2008, 6:03:45 PM (16 years ago)

Author:

landauf

Comment:

—

code/C++_styleguide

@@ -95 +95 @@
 }}}
 Note: try not to fill in the filename. It is obvious and the comment compiler (Doxygen) will do it automatically and you don't have to adjust it when renaming the file.
+
+=== Classes ===
+In the header file, just above the class declaration, explain what the class does and where it is used. You could even add an example if it helps understanding the class.
+{{{
+/**
+@brief
+    A brief description.
+    More brief description.
+
+    Details follow here.
+    Maybe an example or something.
+*/
+}}}
 
 === Functions ===
@@ -111 +124 @@
 @param param2
     Parameter description for parameter named 'param2'
+@return
+    Describe what the function returns
 @note
     Something important to remember.
@@ -116 +131 @@
     The mighty whoever
 */
+}}}
+
+=== Inline Functions ===
+Inline functions need documentation as well, but we don't want a messy headerfile. Keep the comments short and put all doxygen code on one line:
+{{{
+/** @brief A brief description. @param param1 description [...] @return description */
 }}}