Skip to content
This repository

block comments not ignored #142

Closed
backspaces opened this Issue January 05, 2013 · 1 comment

2 participants

backspaces Jeremy Ashkenas
backspaces

Using the latest everything .. sudo npm update -g .. docco apparently has an error ignoring block comments, leaving hashes and the comment body in the generated html.

Here's a test:

cd ~/temp # or wherever you'd like

cat <<EOF>foo.coffee # make a coffee file
# Return a string prepended with "Hello " 
fcn = (s) -> "Hello #{s}"
###
This is a doc comment
But it appears to work incorrectly with docco
###
EOF

coffee -c foo.coffee # compile it
cat foo.js # show it, looks fine
docco foo.coffee # run docco
open docs/foo.html # open in browser
Jeremy Ashkenas
Owner

Docco was never intended or designed to work with block comments. It's a line-comment-only (or literate style, if that's your cup of tea) sort of thing.

Jeremy Ashkenas jashkenas closed this March 12, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.