RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-29 22:30:33 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Revert r189704, which removed the guidance about not duplicating doc comments.

Browse Source 
This is under active discussion.

llvm-svn: 189730
This commit is contained in:
Chris Lattner 2013-09-01 15:48:08 +00:00
parent 04a636836e
commit 4fe35f8960
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/CodingStandards.rst
View File

@ -195,6 +195,13 @@ 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