github-migration/rocco
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

generated rocco.rb doc links to sources for effect

Browse Source
This commit is contained in:
Ryan Tomayko 2010-03-11 06:22:20 -08:00
parent ef7dbdcda0
commit a7282e4606
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/rocco.rb
View File

@ -4,7 +4,7 @@
# Rocco reads Ruby source files and produces annotated source documentation # Rocco reads Ruby source files and produces annotated source documentation
# in HTML format. Comments are formatted with [Markdown][md] and presented # in HTML format. Comments are formatted with [Markdown][md] and presented
# alongside syntax highlighted code so as to give an annotation effect. # alongside syntax highlighted code so as to give an annotation effect.
# This page is the result of running Rocco against its own source file. # This page is the result of running Rocco against [its own source file][so].
# #
# Most of this was written while waiting for [node.js][no] to build (so I # Most of this was written while waiting for [node.js][no] to build (so I
# could use Docco!). Docco's gorgeous HTML and CSS are taken verbatim. # could use Docco!). Docco's gorgeous HTML and CSS are taken verbatim.
@ -12,7 +12,7 @@
# [CoffeeScript][co] and may be a bit easier to obtain and install in # [CoffeeScript][co] and may be a bit easier to obtain and install in
# existing Ruby environments or where node doesn't run yet. # existing Ruby environments or where node doesn't run yet.
# #
# Rocco can be installed with rubygems: # Install Rocco with Rubygems:
# #
# gem install rocco # gem install rocco
# #
@ -27,6 +27,7 @@
# [do]: http://jashkenas.github.com/docco/ # [do]: http://jashkenas.github.com/docco/
# [co]: http://coffeescript.org/ # [co]: http://coffeescript.org/
# [md]: http://daringfireball.net/projects/markdown/ # [md]: http://daringfireball.net/projects/markdown/
# [so]: http://github.com/rtomayko/rocco/blob/master/lib/rocco.rb#commit
#### Prerequisites #### Prerequisites