[cfe-dev] Doxygen comments duplicated in Clang source files : OK to delete them?

[James Dennett]

[ Replying to one point only, for now. ]

On Tue, Jul 3, 2012 at 5:07 PM, Chandler Carruth <chandlerc at google.com> wrote:
> On Tue, Jul 3, 2012 at 4:33 PM, James Dennett <jdennett at google.com> wrote:
>>
>> As I clean up a lot of Clang's comments for Doxygen's consumption, I'm
>> hitting one issue repeatedly: a lot of the documentation is cut+pasted
>> between the header file and the associated source file.  Apart from
>> confusing some configurations of Doxygen (which concatenate the docs,
>> giving duplication in the output), this inevitably leads to bitrot and
>> divergence.
>
>
> I think the duplication is really bad, and I have a moderately strong
> preference for how to de-duplicate:
[...]
>
> Whenever we reach a consensus, James, would you be up for contributing a
> patch adding advice about this to the LLVM coding conventions? We should
> document the resolution of these issues.

No problem, when we appear to have consensus I'll put together a patch.

-- James