couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Couchdb Wiki] Update of "couch_edocs" by mCoolin
Date Thu, 22 Mar 2012 03:19:37 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.

The "couch_edocs" page has been changed by mCoolin:
http://wiki.apache.org/couchdb/couch_edocs?action=diff&rev1=6&rev2=7

  Please note this is a work in progress but over the next few days I hope to have all sections
and modules documentation posted here.
  
  == comment suggestions ==
-  * module comments (more to come)
-  * function comments (more to come)
+  * module comments
+   * By using the edoc  '@doc' tag before the module you can add one or more lines of documentation
for the module
+ 
+  . e.g.
+ 
+  . %% @doc This would be a line of documentation
+ 
+  . %% More lines can be used if needed
+ 
+  * function comments
+   * By using the edoc  '@doc' tag before the function you can add one or more lines of documentation
for the function
+ 
+  . e.g.
+ 
+  . %% @doc This would be a line of documentation
+ 
+  . %% More lines can be used if needed
  
  == link to generated documentation ==
- [[http://couch.erldocs.com/| couch erldocs]]
+ [[http://couch.erldocs.com/|couch erldocs]]
  

Mime
View raw message