[llvm] r189730 - Revert r189704, which removed the guidance about not duplicating doc comments.

[Chris Lattner]

Author: lattner
Date: Sun Sep  1 10:48:08 2013
New Revision: 189730

URL: http://llvm.org/viewvc/llvm-project?rev=189730&view=rev
Log:
Revert r189704, which removed the guidance about not duplicating doc comments.
This is under active discussion.

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=189730&r1=189729&r2=189730&view=diff
==============================================================================
--- llvm/trunk/docs/CodingStandards.rst (original)
+++ llvm/trunk/docs/CodingStandards.rst Sun Sep  1 10:48:08 2013
@@ -195,6 +195,13 @@ 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