-
Notifications
You must be signed in to change notification settings - Fork 616
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
Clean up OpenEXRCore doxygen comments #1130
Clean up OpenEXRCore doxygen comments #1130
Conversation
* Fix improper use of \ref, etc * Fix various warnings * Make consistent use of punctuation, capitalization, and verb tense * Add entries to reference section in OpenEXRCoreAPI.rst to get proper references. Signed-off-by: Cary Phillips <cary@ilm.com>
/** @file */ | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you put the @file markers, if you don't aren't generating per-file docs and you don't have any file-level comments?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While searching for why things weren't showing up, I came across this:
https://www.doxygen.nl/manual/docblocks.html#specialblock
Attention
Let's repeat that, because it is often overlooked: to document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a
/*! \file */
That said, I think I resolved all the issues that led me to add those lines, and I'm not sure they are, in face, necessary, so I may be misinterpreting that statement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, I didn't know that. I retract my question.
I wonder what counts as "global." Maybe the reason that I've never bumped into this is that I'm working in C++ so everything is technically in a namespace, and thus not global? But for these C bindings, there's no enclosing namespace?
* Fix improper use of \ref, etc * Fix various warnings * Make consistent use of punctuation, capitalization, and verb tense * Add entries to reference section in OpenEXRCoreAPI.rst to get proper references. Signed-off-by: Cary Phillips <cary@ilm.com>
* Fix improper use of \ref, etc * Fix various warnings * Make consistent use of punctuation, capitalization, and verb tense * Add entries to reference section in OpenEXRCoreAPI.rst to get proper references. Signed-off-by: Cary Phillips <cary@ilm.com>
references.
Signed-off-by: Cary Phillips cary@ilm.com