6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-12-28 19:31:58 +00:00
Code Issues Projects Releases Wiki Activity

Remove the suggestion to not duplicate comments in header and

Browse Source 
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
This commit is contained in:
Chris Lattner 2013-08-30 23:06:20 +00:00
parent 11addd2a2f
commit af069a8920
1 changed files with 0 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/CodingStandards.rst
View File

@ -195,13 +195,6 @@ A documentation comment that uses all Doxygen features in a preferred way:
/// \returns true on success. /// \returns true on success.
bool fooBar(bool Baz, StringRef Quux, std::vector<int> &Result); 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. 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; For humans it is obvious which function or class is being documented;
automatic documentation processing tools are smart enough to bind the comment automatic documentation processing tools are smart enough to bind the comment