COUCHDB edocs summary of modules
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
- 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