improve doxygen formatting in some Hlms classes

OGRECave / ogre-next

aka ogre v2 - scene-oriented, flexible 3D C++ engine

https://ogrecave.github.io/ogre-next/api/latest

Other

1.03k stars 227 forks source link

improve doxygen formatting in some Hlms classes #456

Closed jwwalker closed 1 month ago

jwwalker commented 2 months ago

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

darksylinc commented 1 month ago

Thanks!

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

jwwalker commented 1 month ago

@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 commented 1 month ago

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".