Update coding style to include a more exact example of using return
Signed-off-by: Scott Zawalski <scottz@google.com>
git-svn-id: http://test.kernel.org/svn/autotest/trunk@4457 592f7852-d20e-0410-864c-8624ca9c26a4
diff --git a/CODING_STYLE b/CODING_STYLE
index b640019..c048c8a 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -103,6 +103,7 @@
@param param1: A thing called param1 that is used for a bunch of stuff
that has methods bar() and baz() which raise SpamError if
something goes awry.
+ @return a list of integers describing changes in a source tree
...
"""
@@ -120,6 +121,8 @@
@raises - If the function can throw an exception, this tag documents the
possible exception types.
+When in doubt refer to: http://doxygen.nl/commands.html
+
Simple code
Keep it simple; this is not the right place to show how smart you are. We