Open FreeSlave opened 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?
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.
One can also use a $(NOTE …)
content block. (Renders as a blue box with the default stylesheet.)
'Note:' should be made into a section like 'Throws:'.