diff options
| author | Chandler Carruth <chandlerc@gmail.com> | 2016-09-01 22:18:25 +0000 |
|---|---|---|
| committer | Chandler Carruth <chandlerc@gmail.com> | 2016-09-01 22:18:25 +0000 |
| commit | 67473526cb503819e0461ce5432fc128dd4207d1 (patch) | |
| tree | 7e8aa0383fe4f188d4767d6436f96f19f5e5ca7a /llvm/docs | |
| parent | 5f17d08f498167c1523136b3e62f51588769152d (diff) | |
| download | bcm5719-llvm-67473526cb503819e0461ce5432fc128dd4207d1.tar.gz bcm5719-llvm-67473526cb503819e0461ce5432fc128dd4207d1.zip | |
Make the coding standards a bit more clear that we prefer the fancy new
auto-brief format for doxygen comments. Most notable is switching to
that in the example doxygen comment. I've also tweaked the wording but
am happy to tweak it further if others have suggestions here.
Mostly doing this to capture something I and others have been writing
consistently and repeatedly in code reviews.
llvm-svn: 280419
Diffstat (limited to 'llvm/docs')
| -rw-r--r-- | llvm/docs/CodingStandards.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/llvm/docs/CodingStandards.rst b/llvm/docs/CodingStandards.rst index e14f63525fc..93feea560ce 100644 --- a/llvm/docs/CodingStandards.rst +++ b/llvm/docs/CodingStandards.rst @@ -267,7 +267,7 @@ code can be distributed under and should not be modified in any way. The main body is a ``doxygen`` comment (identified by the ``///`` comment marker instead of the usual ``//``) describing the purpose of the file. The -first sentence or a passage beginning with ``\brief`` is used as an abstract. +first sentence (or a passage beginning with ``\brief``) is used as an abstract. Any additional information should be separated by a blank line. If an algorithm is being implemented or something tricky is going on, a reference to the paper where it is published should be included, as well as any notes or @@ -322,8 +322,9 @@ comment. Include descriptive paragraphs for all public interfaces (public classes, member and non-member functions). Don't just restate the information that can -be inferred from the API name. The first sentence or a paragraph beginning -with ``\brief`` is used as an abstract. Put detailed discussion into separate +be inferred from the API name. The first sentence (or a paragraph beginning +with ``\brief``) is used as an abstract. Try to use a single sentence as the +``\brief`` adds visual clutter. Put detailed discussion into separate paragraphs. To refer to parameter names inside a paragraph, use the ``\p name`` command. @@ -351,7 +352,7 @@ A documentation comment that uses all Doxygen features in a preferred way: .. code-block:: c++ - /// \brief Does foo and bar. + /// Does foo and bar. /// /// Does not do foo the usual way if \p Baz is true. /// |
