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

improve doxygen formatting in some Hlms classes #456

Merged
merged 1 commit into from
Jul 31, 2024

Conversation

jwwalker
Copy link
Contributor

improve doxygen formatting in Hlms, HlmsDatablock, HlmsPbsDatablock, and HlmsListener classes

@darksylinc darksylinc merged commit c366477 into OGRECave:master Jul 31, 2024
2 checks passed
@darksylinc
Copy link
Member

Thanks!

I'm curious: What sort of cursed formatting needs "i.e. explanation" to become "i.e., explanation" ?

@jwwalker
Copy link
Contributor Author

jwwalker commented Jul 31, 2024

@darksylinc In some cases, I'm not sure of the exact rules, the period followed by a space made Doxygen do a paragraph break. But I was taught in school that putting a comma after "i.e." and "e.g." is more correct anyway, so I didn't bother looking deeper.

@jwwalker jwwalker deleted the jw/hlms-doc-fixes branch July 31, 2024 19:41
@jwwalker
Copy link
Contributor Author

I think it's that Ogre sets the Doxygen setting JAVADOC_AUTOBRIEF to YES, which means that "Doxygen will interpret the first line (until the first dot) of a Javadoc-style comment as the brief description".

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

Successfully merging this pull request may close these issues.

2 participants