Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
FreeSlave opened this issue May 30, 2018 · 3 comments
Open

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

FreeSlave opened this issue May 30, 2018 · 3 comments

Comments

@FreeSlave
Copy link

/**
 * 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
Copy link
Owner

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
Copy link
Author

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
Copy link
Contributor

0xEAB commented Aug 18, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants