Changes between Version 6 and Version 7 of CodeStyleAndDocumentation

Timestamp:

03/04/11 17:36:31 (2 years ago)

Author:

lelian (IP: 172.29.29.52)

Comment:

--

CodeStyleAndDocumentation

@@ -1 +1 @@
 
-== Code style and documentation ==
+== Code style ==
 
  * [http://www.helenos.org/cstyle Official C-style of HelenOS]
@@ -14 +14 @@
    * Debug2
 
-=== Doxygen ===
+== Reference documentation (doxygen) ==
 The [attachment:Doxyfile attachment] contains configuration file for generating code documentation for userspace (AMD64 port). Adjust `OUTPUT_DIRECTORY` and `INPUT` to your local paths.
 
 Updated to bypass problem with `__atribute__(packed)` (see tag `PREDEFINED`).
+
+=== Documenting functions ===
+
+'''All functions''' (both 'public' and 'private') should have at least:
+ * ''short description'' stating what the function does (and what it does not)
+ * ''list of parameters'' with descriptions
+ * description of all ''return values''
+
+Implementation details '''should not''' be part of the reference documentation
 
 == Developer documentation ==