<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><div><div>On Jul 3, 2012, at 5:07 PM, Chandler Carruth wrote:</div><blockquote type="cite"><div class="gmail_extra"><div class="gmail_quote">On Tue, Jul 3, 2012 at 4:33 PM, James Dennett <span dir="ltr"><<a href="mailto:jdennett@google.com" target="_blank" class="cremed">jdennett@google.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0.8ex; border-left-width: 1px; border-left-color: rgb(204, 204, 204); border-left-style: solid; padding-left: 1ex; position: static; z-index: auto; ">As I clean up a lot of Clang's comments for Doxygen's consumption, I'm<br>
hitting one issue repeatedly: a lot of the documentation is cut+pasted<br>
between the header file and the associated source file. Apart from<br>
confusing some configurations of Doxygen (which concatenate the docs,<br>
giving duplication in the output), this inevitably leads to bitrot and<br>
divergence.<br></blockquote><div><br></div><div>I think the duplication is really bad, and I have a moderately strong preference for how to de-duplicate:</div></div></div></blockquote><div><br></div>Sorry to be a contrarian again, but I find it really useful to have the copy-and-pasted doc comments on methods implementations in the .cpp files as well as on the prototypes in the header. It is really common for me to be working on a .cpp file without the header open, and losing the doc comments is a big loss.</div><div><br></div><div>If the goal is to avoid bitrot and divergence, why not make the doc comment parser note divergence and warn about it?</div><div><br></div><div>-Chris</div></body></html>