[PATCH] D42850: [docs] Add guidance on duplicating doc comments to CodingStandards

[Philip Reames via Phabricator via llvm-commits]

reames requested changes to this revision.
reames added inline comments.
This revision now requires changes to proceed.


================
Comment at: docs/CodingStandards.rst:324
 ``\brief`` adds visual clutter.  Put detailed discussion into separate
-paragraphs.
+paragraphs. Avoid duplicating documentation for overridden methods. When
+extending documentation from the superclass, the ``\copydoc name`` command can
----------------
I'd suggest reframing this to focus on what should you document for the override version.  i.e. When documenting override methods, highlight the differences with parent implementation.  Instead of duplicating the existing documentation, refer to it if needed.  If the documentation for the overridden method is sufficient to document the override's behaviour, omit documentation of the override.


Repository:
  rL LLVM

https://reviews.llvm.org/D42850