[llvm] r189704 - Remove the suggestion to not duplicate comments in header and

[Chris Lattner]

Author: lattner
Date: Fri Aug 30 18:06:20 2013
New Revision: 189704

URL: http://llvm.org/viewvc/llvm-project?rev=189704&view=rev
Log:
Remove the suggestion to not duplicate comments in header and
implementation files.  While doc generation systems don't need this,
humans do benefit from it.  Not everyone reads all code through doxygen.

Modified:
    llvm/trunk/docs/CodingStandards.rst

Modified: llvm/trunk/docs/CodingStandards.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CodingStandards.rst?rev=189704&r1=189703&r2=189704&view=diff
==============================================================================
--- llvm/trunk/docs/CodingStandards.rst (original)
+++ llvm/trunk/docs/CodingStandards.rst Fri Aug 30 18:06:20 2013
@@ -195,13 +195,6 @@ A documentation comment that uses all Do
   /// \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