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

Merge branch 'docblock-annotations' of https://github.com/bobthecow/rocco into bobthecow-docblock-annotations

Browse Source
This commit is contained in:
Mike West 2011-04-19 19:44:39 +02:00
commit c1afb8a0d4
3 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/rocco
View File

@ -8,6 +8,7 @@
#/ The string to recognize as a comment marker #/ The string to recognize as a comment marker
#/ -o, --output=<dir> Directory where generated HTML files are written #/ -o, --output=<dir> Directory where generated HTML files are written
#/ -t, --template=<path> The file to use as template when rendering HTML #/ -t, --template=<path> The file to use as template when rendering HTML
#/ -d, --docblocks Parse Docblock @annotations in comments
#/ --help Show this help message #/ --help Show this help message
require 'optparse' require 'optparse'
@ -39,6 +40,7 @@ ARGV.options { |o|
o.on("-l", "--language=LANG") { |lang| options[:language] = lang } o.on("-l", "--language=LANG") { |lang| options[:language] = lang }
o.on("-c", "--comment-chars=CHARS") { |chars| options[:comment_chars] = Regexp.escape(chars) } o.on("-c", "--comment-chars=CHARS") { |chars| options[:comment_chars] = Regexp.escape(chars) }
o.on("-t", "--template=TEMPLATE") { |template| options[:template_file] = template } o.on("-t", "--template=TEMPLATE") { |template| options[:template_file] = template }
o.on("-d", "--docblocks") { options[:docblocks] = true }
o.on_tail("-h", "--help") { usage($stdout, 0) } o.on_tail("-h", "--help") { usage($stdout, 0) }
o.parse! o.parse!
} or abort_with_note } or abort_with_note

15
lib/rocco.rb
View File

@ -383,11 +383,26 @@ class Rocco
[docs_blocks, code_blocks] [docs_blocks, code_blocks]
end end
# Take a list of block comments and convert Docblock @annotations to
# Markdown syntax.
def docblock(docs)
docs.map do |doc|
doc.split("\n").map do |line|
line.match(/^@\w+/) ? line.sub(/^@(\w+)\s+/, '> **\1** ')+" " : line
end.join("\n")
end
end
# Take the result of `split` and apply Markdown formatting to comments and # Take the result of `split` and apply Markdown formatting to comments and
# syntax highlighting to source code. # syntax highlighting to source code.
def highlight(blocks) def highlight(blocks)
docs_blocks, code_blocks = blocks docs_blocks, code_blocks = blocks
# Pre-process Docblock @annotations.
if @options[:docblocks]
docs_blocks = docblock(docs_blocks)
end
# Combine all docs blocks into a single big markdown document with section # Combine all docs blocks into a single big markdown document with section
# dividers and run through the Markdown processor. Then split it back out # dividers and run through the Markdown processor. Then split it back out
# into separate sections. # into separate sections.

13
test/test_docblock_annotations.rb Normal file
View File

@ -0,0 +1,13 @@
require File.expand_path('../helper', __FILE__)
class RoccoDocblockAnnotationsTest < Test::Unit::TestCase
def test_docblock_annotation_conversion
r = Rocco.new( 'test', '', { :language => "c", :docblocks => true } ) { "" } # Generate throwaway instance so I can test `parse`
assert_equal(
[
"Comment\n\n> **param** mixed foo \n> **return** void "
],
r.docblock( ["Comment\n\n@param mixed foo\n@return void"] )
)
end
end