Fix miscellaneous formatting problems, typos etc. in some of the docs #461
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mentation comments.
eugenegff
force-pushed
the
master
branch
2 times, most recently
from
2ee1c83
to
8b3ddcc
Compare
eugenegff
force-pushed
the
master
branch
2 times, most recently
from
8fac6ae
to
759d2f8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.