Skip to content

Update CODING_STANDARD.md #1959

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

Update CODING_STANDARD.md #1959

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3495f45
Update CODING_STANDARD.md
Mar 22, 2018
39e501f
Update CODING_STANDARD.md
Mar 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CODING_STANDARD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ Formatting is enforced using clang-format. For more information about this, see
/// This sentence, until the first dot followed by whitespace, becomes
/// the brief description. More detailed text follows. Feel free to
/// break this into paragraphs to aid readability.
/// \param arg_name: This parameter doesn't need much description
/// \param [out] long_arg_name: This parameter is mutated by the function.
/// \param arg_name This parameter doesn't need much description
/// \param [out] long_arg_name This parameter is mutated by the function.
/// Extra info about the parameter gets indented an extra two columns,
/// like this.
/// \return The return value is literally the value returned by the
Expand All @@ -77,6 +77,7 @@ Formatting is enforced using clang-format. For more information about this, see
- The priority of documentation is readability. Therefore, feel free to use
Doxygen features, or to add whitespace for multi-paragraph comment blocks if
necessary.
- When describing parameters of functions, you may use a colon after the parameter name but if you choose to do so, do not add a space between the name and the colon as this will show in the generated documentation. For example, both `\param arg_name ...` and `\param arg_name: ...` are fine but `\param arg_name : ...` should be avoided.
- A comment block should immediately precede the definition of the entity it
documents, which will generally mean that it will live in the source file.
This allows us to take advantage of the one definition rule. If each entity
Expand Down