colons make the line h2 about dox HOT 9 CLOSED

I have a lot that look like "Examples: " etc, that if for nothing other than backwards compat I would like to retain that functionality, but other than that I agree. I think we should only transform it to an h2 when it's short though

from dox.

It's a bit obscur, if it's short h2, if not p ...

from dox.

yup it is but I don't want to go redo docs for hundreds of projects :p

from dox.

I can understand. How to you produce your doc, because dox output is in json. Maybe this feature, "small words with colons becomes h2" could be a feature of the documentation generator and not of javadoc parser (dox) ?

from dox.

It's an interesting point, you can ask for dox to give you the markdown directly, and then parse it yourself. I do this myself in my own docs generating library (very much at an alpha stage at the moment) so I can parse the markdown myself and add syntax highlighting at the same time

• The Repo - https://github.com/jepso/gitdocs
• The Call to docs is in https://github.com/jepso/gitdocs/blob/master/filehandler/filehelpers.js
• You can see the output by running npm install gitdocs -g then cd-ing to a directory with some code in it and running gitdocs then browsing to localhost:2000

This method lets you get complete control over the parsing.

from dox.

Thanks ForbesLindesay, I think you mean the raw option ?

I already notice this option. But when I parse Example: and ## Example: there is no diffrence in the output even if with the raw option. Both outputs are:

"description": {
      "full": "Parse the given `str`.\n\n## Examples:\n\n    parse(str)\n    // => \"wahoo\"\n",
      "summary": "Parse the given `str`.",
      "body": "## Examples:\n\n    parse(str)\n    // => \"wahoo\"\n"
    }

Because of this line: .replace(/^([A-Z][\w ]+):$/gm, '## $1')

from dox.

Sorry miss click on Close & comment

from dox.

ouch, that does seem like a bug to me, I don't think we should do the conversion in raw mode. @visionmedia what are your thoughts?

from dox.

I dont remember what I did ATM but yeah if it's in .raw that's no good

from dox.