[Mono-docs-list] Re: Status of documentation and docstub
John Barnette
jbarn@httcb.net
Fri, 22 Mar 2002 10:46:17 -0700
Hi Adam,
This is great! I have a few small nits to pick. Sorry I can't send
you a patch, but I'm still stuck away from my normal computer (sigh).
At Friday, 22 March 2002, you wrote:
><?xml version="1.0"?>
><monodoc language="en">
> <summary>description</summary>
> <remarks>description</remarks>
These two tags (<summary> and <remarks>) aren't really necessary,
as they aren't documenting anything.
> <struct name="System.Drawing.Point" assembly="System.Drawing">
> <summary>description</summary>
> <remarks>description</remarks>
> <seealso cref="description" />
I don't think there's any reason to stub a <seealso> here, since
it's information purely up to the documentor.
Besides that, it looks awesome! One other request: could we use
'TODO' or something similar in place of 'description'? It'll make
generating percentage-complete statistics and such considerably easier.
~ j.