Created
December 14, 2011 14:49
-
-
Save mxriverlynn/1476877 to your computer and use it in GitHub Desktop.
docco
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sudo npm install -g coffee-script |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docco comments.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// 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!"); | |
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sudo npm install -g docco |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sudo brew install node |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sudo curl http://npmjs.org/install.sh | sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sudo easy_install pygments | |
sudo npm install -g pygments |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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