[LLVMdev] [cfe-commits] Duplicating routine/class name in documentation comment.

Matthieu Monrocq matthieu.monrocq at gmail.com
Tue Oct 30 11:05:39 PDT 2012

On Tue, Oct 30, 2012 at 3:02 PM, Mahesha HS <mahesha.llvm at gmail.com> wrote:

> I understand that current coding guidelines are strictly against
> duplicating routine/class name in documentation comment though old
> code is written that way, but, I could still see this kind of
> duplication in few recent check-ins, after I got this review comment
> for one of my recent patches. So, I am curious to send this mail.
> --
> mahesha
> _______________________________________________
> cfe-commits mailing list
> cfe-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits

It is generally discouraged because duplication causes documentation to go
out of date whenever the function/class name changes: it's a drag to
remember to update the comment and many times people don't.

Instead, it's simply easier to let Doxygen correctly assess which
class/function the comment targets. It just works!

-- Matthieu
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-dev/attachments/20121030/731051f8/attachment.html>

More information about the llvm-dev mailing list