Skip to content

Instantly share code, notes, and snippets.

@mxriverlynn
Created December 14, 2011 14:49
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mxriverlynn/1476877 to your computer and use it in GitHub Desktop.
Save mxriverlynn/1476877 to your computer and use it in GitHub Desktop.
docco
sudo npm install -g coffee-script
docco comments.js
// This Is A Header
// ----------------
// This is a normal comment, that will become part of the
// annotations after running through the Docco tool. Use this
// space to describe the function or other code just below
// this comment. For example:
//
// The `DoSomething` method does something! It doesn't take any
// parameters... it just does something.
function DoSomething(){
// and by the way, this will show up
// in the docco file, too. :)
alert("I'm doing something!");
}
sudo npm install -g docco
sudo brew install node
sudo curl http://npmjs.org/install.sh | sh
sudo easy_install pygments
sudo npm install -g pygments
desc "Build the Docco annotated source documentation"
task :docco do
`docco comments.js`
end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment