It is sometimes necessary to add a comma after "i.e." or "e.g." to prevent an unintended paragraph break, due to Ogre's use of the JAVADOC_AUTOBRIEF Doxygen setting.
@see should not be used inside a paragraph, only as a freestanding item, because it starts a new paragraph.
I resorted to HTML to get a decent rendering of the formula in Light::setAttenuationBasedOnRadius.
When I was modifying a file for other reasons, I also fixed incorrect usage of "it's". The rule is that "it's" is a contraction for "it is" or "it has", while "its" is used for the possessive, "belonging to it". Yes, this is inconsistent with other English possessives.
A few specifics:
It is sometimes necessary to add a comma after "i.e." or "e.g." to prevent an unintended paragraph break, due to Ogre's use of the
JAVADOC_AUTOBRIEFDoxygen setting.@seeshould not be used inside a paragraph, only as a freestanding item, because it starts a new paragraph.I resorted to HTML to get a decent rendering of the formula in
Light::setAttenuationBasedOnRadius.When I was modifying a file for other reasons, I also fixed incorrect usage of "it's". The rule is that "it's" is a contraction for "it is" or "it has", while "its" is used for the possessive, "belonging to it". Yes, this is inconsistent with other English possessives.