You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm using docco on a node.js project, and nowhere in the page http://jashkenas.github.io/docco/ is the list of comment sugar, if any, Docco supports. I Joogled several times, finally ending up on a bunch of closed issues that I gather docco supports single line comments in the language's native one line comment format. It would be nice if the web page stated that not so obvious fact. I came in assuming you'd grok the popular comment sugar like /** /, etc, and maybe even @Class and @function voodoo. Now I've got 0 issue with the fact it doesn't do any of this, but I burnt 30 minutes trying to figure out this fact. I'm building a REST API, so I need to document the REST endpoints, and thought docco might assist. Again, no issues there, but the home page should maybe state that
"Docco [currently] supports single line comments in the language's native format. It doesn't [currently] support any other documentation system's comment sugar"
The text was updated successfully, but these errors were encountered:
I'm using docco on a node.js project, and nowhere in the page http://jashkenas.github.io/docco/ is the list of comment sugar, if any, Docco supports. I Joogled several times, finally ending up on a bunch of closed issues that I gather docco supports single line comments in the language's native one line comment format. It would be nice if the web page stated that not so obvious fact. I came in assuming you'd grok the popular comment sugar like /** /, etc, and maybe even @Class and @function voodoo. Now I've got 0 issue with the fact it doesn't do any of this, but I burnt 30 minutes trying to figure out this fact. I'm building a REST API, so I need to document the REST endpoints, and thought docco might assist. Again, no issues there, but the home page should maybe state that
The text was updated successfully, but these errors were encountered: