[Mono-docs-list] using mdoc to report doc/code differences?
jonpryor at vt.edu
Tue Jan 12 14:45:53 EST 2010
On Tue, 2010-01-12 at 10:57 -0800, Arne Claassen wrote:
> On Jan 12, 2010, at 10:20 AM, Jonathan Pryor wrote:
> > Of course, this is ~trivially "subverted" -- the <include/> could
> > refer
> > to documentation which just says "To be added", which isn't very
> > useful.
> Plus the first time update runs, that "To be added" doc will be
> generated anyhow. And if i am to go external with docs, i'd rather be
> completely external.
True, but if you warn on 'To be added,' that's not actually a problem --
you'll still get a warning/error.
> > However, what should the semantics be? *All* elements shouldn't have
> > 'To be added', or can some have it, etc.
> For my case at least i would want the error to be on anything not
> properly documented.
Yeah. Semantics. What's "properly documented," particular in a manner
that a computer can understand, check for, and enforce. :-)
More information about the Mono-docs-list