Global option for inheritdoc ?

Dec 20, 2011 at 10:59 AM



i understand the usage of the <inheritdoc/> Tag. But it's annoying to add the tag to every inherited framework-member (GetType(), ToString(), ...).
Is it possible to set a global option so that documentation is inherited by default for undocumented members?


Best regards,


Dec 20, 2011 at 3:39 PM

Hello Christian,

Have you actually added comments to GetType() and found it annoying?

Yes, it is possible. But, if you are looking for pony, there is none!

Sandcastle is an extensible framework, and the copying of comments and others are done
by concrete implementations of the abstract class CopyComponent. So, if you find it
less annoying to check each API and test each comment part (summary, parameters, value,
remarks, exception, return etc) for empty fields and copying the part as needed, then you
can take that path, providing such implementation of the CopyComponent.

Best regards,