[Mono-docs-list] MonoDoc XML and Overloads

John Barnette jbarn@httcb.net
Sat, 16 Mar 2002 18:38:36 -0700

At 05:18 PM 3/16/2002, Jason Diamond wrote:
>I was just looking at the MonoDoc document and noticed that it doesn't have
>any sort of construct to document overloaded members. Take a look at the
>System.Xml.XmlNode.Item overloads, for example. If you look at the page that
>summarizes all the overloads of that property [1], you'll see that the
>summary at the top of that page doesn't match the summary at the top of each
>of the individual overload pages [2][3].
>In NDoc, we added support for an <overloads> element. This isn't supported
>or documented anywhere by Microsoft but we wanted to have the same control
>that they obviously have. We currently check the <overloads> element for
><summary>, <example>, and <note> elements (see the
>System.Xml.XmlDocument.Load overloads [4] for an example of a note in the
>overloads page). The <overloads> element can be "attached" to any overload
>in the source file. If there is no member with an <overloads> element, then
>we just grab the first <summary> from the first overloaded memeber. MonoDoc
>can obviously do something different here since you're not extracting your
>documentation from the source. It should still be possible to convert
>MonoDoc to something that looks like the CSC-generated XML documentation
>file so that we can feed it to NDoc.

Hey Jason,

Thanks for noticing this; you appear to be solving it in a good way.  Is 
there a document available anywhere in the NDoc source tree that documents 
(a) all the tags in an input file that you perform special processing on 
and (b) any extensions that you've added?  Since we're assuming generation 
with NDoc, I'd like to make interop as smooth as possible.

Also, I've been unable to find any good documentation of the <note> tag; 
any pointers?

~ j.