From 4fe2746c5ffe5226446d5632a367fb4a30d456c2 Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Sun, 1 Sep 2013 15:48:08 +0000 Subject: Revert r189704, which removed the guidance about not duplicating doc comments. This is under active discussion. llvm-svn: 189730 --- llvm/docs/CodingStandards.rst | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'llvm/docs') diff --git a/llvm/docs/CodingStandards.rst b/llvm/docs/CodingStandards.rst index 3bf62514a9d..9418680edc7 100644 --- a/llvm/docs/CodingStandards.rst +++ b/llvm/docs/CodingStandards.rst @@ -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 &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 -- cgit v1.2.3