Changes between Version 20 and Version 21 of code/C++_styleguide

Timestamp:

Sep 20, 2008, 5:53:56 PM (17 years ago)

Author:

rgrieder

Comment:

—

code/C++_styleguide

@@ -87 +87 @@
 {{{
 /**
-    @file
-    @brief A brief description.
-
-    More description...
+@file
+@brief
+    A brief description.
+
+    More description... (new paragraph after @brief)
 */
 }}}
 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.
+
+=== Functions ===
+Doxygen documentation (javadoc like for C++) is placed in the source file, just above the function header. If the function is inline, place the comment there but keep it short. [[br]]
+When writing documentation in the source file don't make it all jam-packed to enhance readability. Here is an example to demonstrate formatting:
+{{{
+/**
+@brief
+    A brief description.
+    More brief description.
+
+    Details follow here.
+    Maybe an example or something.
+@param param1
+    Parameter description for parameter named 'param1'
+@param param2
+    Parameter description for parameter named 'param2'
+@note
+    Something important to remember.
+@author
+    The mighty whoever
+*/
 
 == Naming Conventions ==