diff options
| author | Chris Lattner <sabre@nondot.org> | 2013-08-30 23:06:20 +0000 |
|---|---|---|
| committer | Chris Lattner <sabre@nondot.org> | 2013-08-30 23:06:20 +0000 |
| commit | af069a8920098843cda3352c3e2614ff5164e1b7 (patch) | |
| tree | ed1b583fded145986cefe4e47cddc8024b7b75a0 /docs | |
| parent | 11addd2a2f584571ffcfd51711972b27aef0133f (diff) | |
| download | external_llvm-af069a8920098843cda3352c3e2614ff5164e1b7.zip external_llvm-af069a8920098843cda3352c3e2614ff5164e1b7.tar.gz external_llvm-af069a8920098843cda3352c3e2614ff5164e1b7.tar.bz2 | |
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.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189704 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CodingStandards.rst | 7 |
1 files changed, 0 insertions, 7 deletions
diff --git a/docs/CodingStandards.rst b/docs/CodingStandards.rst index 9418680..3bf6251 100644 --- a/docs/CodingStandards.rst +++ b/docs/CodingStandards.rst @@ -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 |