[Mono-docs-list] using mdoc to report doc/code differences?

Arne Claassen arnec at mindtouch.com
Mon Jan 11 19:32:54 EST 2010


I've been using the inline Xml Docs for one main reason: Separate  
documentation too often leads to documentation rot. I especially like  
that I get warnings about missing or extra documentation members as  
part of my build. But I have to agree that it makes the code hideous  
and it's a less than ideal editing experience with xml inside of  
comments.

I was wondering if there is a way to call mdoc to report inconsistency  
for a type member, so i could put mdoc update and inconsistency  
checking into the build. The default output is a bit too verbose to  
highlight the problems encountered.

thanks,
Arne Claassen

MindTouch
San Diego, CA
http://twitter.com/sdether



More information about the Mono-docs-list mailing list