Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated README.md

  • Loading branch information...
commit 208e5d0275e5fa0f5d9e6e6919ffca167daf7144 1 parent 616007f
@lmaccherone authored
Showing with 5 additions and 0 deletions.
  1. +5 −0 README.md
View
5 README.md
@@ -71,6 +71,8 @@ CoffeeDoc can be run from the command line:
-o, --output: Set output directory (default: ./docs)
--commonjs : Use if target scripts use CommonJS for module loading (default)
--requirejs : Use if target scripts use RequireJS for module loading
+ --readme : Generates a draft README.md from the module docstrings
+ -r, --rout : Set output file for README.md (defaults to stdout)
If [targets] is a directory, CoffeeDoc will recursively document all `.coffee`
files found under that directory.
@@ -79,6 +81,9 @@ If you wish to document several modules, make sure you generate all
the docs with a single command -- this ensures that they will all appear in the
`index.html` file.
+Note that since coffeedoc is intended to document the public API, any functions or
+methods that begin with underscore (`_`) will be omitted from the generated docs.
+
#### Note on Markdown headers ####
Markdown uses `#` characters for headers, e.g.
Please sign in to comment.
Something went wrong with that request. Please try again.