adamdruppe / adrdox

41 stars 15 forks source link

'Note:' does not become a section in docs #27

Open FreeSlave opened 6 years ago

FreeSlave commented 6 years ago
/**
 * Some doc comments.
 * Note:
 *  Some note.
 * Throws:
 *  Exception
 */
void someFunc()
{

}

screenshot from 2018-05-30 17-22-43

'Note:' should be made into a section like 'Throws:'.

adamdruppe commented 6 years ago

So I actually didn't do this one because I frequently wrote Note: and want it to just be a note instead of a big section.

How often do you actually use this as a section? Would you be ok if it only accepted "Notes:", with the s?

FreeSlave commented 6 years ago

I often use 'Note:'. I know it's nonstandard though, but ddox consider it as section. It's actually not a big deal whether it's section or not, I just used to not write empty comment line between main description and Note. But without empty line and without Note being a section all Note text goes to the main description that appears in overview. I can just add empty lines to my docs to separate Note from the rest.

0xEAB commented 3 months ago

One can also use a $(NOTE …) content block. (Renders as a blue box with the default stylesheet.)