<br><br><div class="gmail_quote">On Tue, Oct 30, 2012 at 3:02 PM, Mahesha HS <span dir="ltr"><<a href="mailto:mahesha.llvm@gmail.com" target="_blank">mahesha.llvm@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
I understand that current coding guidelines are strictly against<br>
duplicating routine/class name in documentation comment though old<br>
code is written that way, but, I could still see this kind of<br>
duplication in few recent check-ins, after I got this review comment<br>
for one of my recent patches. So, I am curious to send this mail.<br>
<span class="HOEnZb"><font color="#888888"><br>
<br>
--<br>
mahesha<br>
_______________________________________________<br>
cfe-commits mailing list<br>
<a href="mailto:cfe-commits@cs.uiuc.edu">cfe-commits@cs.uiuc.edu</a><br>
<a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits" target="_blank">http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits</a><br>
</font></span></blockquote></div><br>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.<br>
<br>Instead, it's simply easier to let Doxygen correctly assess which class/function the comment targets. It just works!<br><br>-- Matthieu<br>