docs: comments are now more specific in code style. #964
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.
This PR makes comments more specific in the code style, as it now has a demonstration of how we want comments, along with defining how general comments in a cpp should look (as we've have several cases of a mis-match in comment styles).
This PR also moves all the code from the coding style guide, into its own folder in example_code. This code isn't checked by the examples runner so it won't ever cause issues.
Documentation change checklist
doxygen
, and testing examples).