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

Timestamp:

Sep 20, 2008, 6:40:53 PM (16 years ago)

Author:

landauf

Comment:

—

code/C++_styleguide

@@ -107 +107 @@
     Maybe an example or something.
 */
+class ClassName
+{
+    ...
+}}}
+
+=== Class Members ===
+Add a brief description to every member of a class:
+{{{
+    private:
+        int value_;           //!< A brief description
+        int longerValueName_; //!< A brief description
+}}}
+The < after //! indicates that the member is located in front of the comment instead of after the comment.
+
+If you need a more detailed description, use:
+{{{
+    private:
+        int value_; //!< A detailed description
+                    //!< More detailed description
+                    //!< ...
+}}}
+or
+{{{
+    private:
+        int value_; /**<
+                        A detailed description
+                        More detailed description
+                        ...
+                    */
 }}}
 
@@ -131 +160 @@
     The mighty whoever
 */
+returntype functionname(type1 param1, type2 param2)
+{
+    ...
 }}}
 
@@ -137 +169 @@
 {{{
 /** @brief A brief description. @param param1 description [...] @return description */
+inline returntype functionname(type1 param1 [, ...]) { ... }
 }}}