Signed-off-by: Mike Holmes <[email protected]>
---
CONTRIBUTING | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/CONTRIBUTING b/CONTRIBUTING
index 08887de..91e2aa9 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -49,6 +49,19 @@ compiler:
Please ensure submitted patches are checkpatch clean before submitting
them to avoid having them automatically returned for rework.
+Documenting the code
+
+Allow doxygen to use all its default behaviors to identify tagged information
but where a doxygen tag must be specified use @
+The first line is by default the brief summary.
+The next paragraph is by default the detailed summary
+Normal comment sections should be before the code block and start with /** on
its own line and finish with */ on its own line.
+Commenting on the end of a line for #defines and struct members is allowed
using /**< <text> */
+Files should start with a files description using @file
+Functions should specify their parameters with @param[in] and @param[out]
+Functions return values should all be specified using @return
+There should be no doxygen warnings or errors generated.
+
+
[1]
https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle
[2]
https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches
[3] refer to README file.
--
1.9.1
_______________________________________________
lng-odp mailing list
[email protected]
http://lists.linaro.org/mailman/listinfo/lng-odp
