thomasvs - flumotion/trunk/doc/random

[flumotion-commit at lists.fluendo.com]

Author: thomasvs
Date: Wed Jan 24 10:31:06 2007
New Revision: 4432

Removed:
   flumotion/trunk/doc/random/documenting
Modified:
   flumotion/trunk/doc/random/styleguide
Log:
fold documenting into styleguide

Modified: flumotion/trunk/doc/random/styleguide
==============================================================================
--- flumotion/trunk/doc/random/styleguide	(original)
+++ flumotion/trunk/doc/random/styleguide	Wed Jan 24 10:31:06 2007
@@ -9,7 +9,13 @@
 
 API DOCS
 --------
-- We use epydoc and epydoc markup for API docs
+- We use epydoc and epydoc markup for API docs (see http://epydoc.sf.net/)
+
+- all public methods should be documented, along with parameters and
+  return values
+  @param, @type, @returns, @rtype
+- public instance vars should be documented
+  @ivar, @type
 - list @param before @type: what it actually does is more useful to know
   than the type
 - align the var/param name: