Skip to content

Commit

Permalink
Remove the suggestion to not duplicate comments in header and
Browse files Browse the repository at this point in the history
implementation files.  While doc generation systems don't need this,
humans do benefit from it.  Not everyone reads all code through doxygen.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189704 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
lattner committed Aug 30, 2013
1 parent 11addd2 commit af069a8
Showing 1 changed file with 0 additions and 7 deletions.
7 changes: 0 additions & 7 deletions docs/CodingStandards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -195,13 +195,6 @@ A documentation comment that uses all Doxygen features in a preferred way:
/// \returns true on success.
bool fooBar(bool Baz, StringRef Quux, std::vector<int> &Result);

Don't duplicate the documentation comment in the header file and in the
implementation file. Put the documentation comments for public APIs into the
header file. Documentation comments for private APIs can go to the
implementation file. In any case, implementation files can include additional
comments (not necessarily in Doxygen markup) to explain implementation details
as needed.

Don't duplicate function or class name at the beginning of the comment.
For humans it is obvious which function or class is being documented;
automatic documentation processing tools are smart enough to bind the comment
Expand Down

0 comments on commit af069a8

Please sign in to comment.