-
Notifications
You must be signed in to change notification settings - Fork 516
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
Docs: update doxygen support #1622
Conversation
Disable special IDL processing which mangles some of our code badly, hiding getter/setter's for some classes. Enable Markdown .md files to be used instead of our custom .dox files. This requires doxygen 1.8.1 or later with Markdown enabled.
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.
Please share a pointer to the resulting diff exposing changes in Doxygen-generated content.
Co-authored-by: Alex Rousskov <[email protected]>
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.
Please share a pointer to the resulting diff exposing changes in Doxygen-generated content.
The first change; to the
The second change; to the
... where the candidates lists every class where the member name is used by a getter OR setter. After this PR disabling the hints, doxygen correctly lists more of these candidate lists narrowing it down to only getter or setter. Am not sure why or what is going on - but we are not producing IDL hint files so disabling that unused feature entirely for now. |
ok to test |
header regenerated using:
|
A meeting discussion addressed my concern.
@yadij, I have adjusted PR description to (IMHO) better describe what happened in this PR, but I do not insist on those adjustments. Please feel free to merge with them, without them, or with some further corrections/edits. Thank you. |
Doxygen v1.7.5 changed HTML_HEADER requirements: We now need to add an open div element to the header that Doxygen then closes for us. This change also fixes the corresponding generated content on Squid website. Also, disable IDL_PROPERTY_SUPPORT which has been causing some errors with output getter/setter matching in the generated output.
Doxygen v1.7.5 changed HTML_HEADER requirements: We now need to add an
open div element to the header that Doxygen then closes for us. This
change also fixes the corresponding generated content on Squid website.
Also, disable IDL_PROPERTY_SUPPORT which has been causing some errors
with output getter/setter matching in the generated output.