[Mono-list] Status of documentation and docstub

Adam Treat manyoso@yahoo.com
Fri, 22 Mar 2002 01:58:26 -0800


Hi all,

I've completed the rework of docstub in reflection of John's updated DTD.   
The tool is ready to be tested, so please, bang it around a little and let me 
know if any changes are needed.   You can find both docstub.cs and the DTD 
under mono/mcs/doctools.  You'll need to use it with Microsoft's SDK at this 
time, because it requires several bits missing from our class libraries.  To 
use: 

docstub -l <lang> -d <directory> -a <assembly>

   -d     The directory to write the xml files to.
   -a     Specifies the target assembly to load and parse.
   -l      Specifies the language encoding.

When it completes you should find your stub in the specified directory and 
namespace subdirectories.  Also, make sure you are using bash since I've used 
'/' as the directory delimiter (I'm using wine ;-)

Enjoy!

Adam

ps:Here is a brief example of generated stub for our System.Drawing.Point.xml:

<?xml version="1.0"?>
<monodoc language="en">
    <summary>description</summary>
    <remarks>description</remarks>
    <struct name="System.Drawing.Point" assembly="System.Drawing">
        <summary>description</summary>
        <remarks>description</remarks>
        <seealso cref="description" />
        <constructor name="System.Drawing.Point(System.Int32)">
            <summary>description</summary>
            <remarks>description</remarks>
            <param name="dw">description</param>
            <seealso cref="description" />
        </constructor>
        <constructor name="System.Drawing.Point(System.Drawing.Size)">
            <summary>description</summary>
            <remarks>description</remarks>
            <param name="sz">description</param>
            <seealso cref="description" />
        </constructor>
        <constructor name="System.Drawing.Point(System.Int32, System.Int32)">
            <summary>description</summary>
            <remarks>description</remarks>
            <param name="x">description</param>
            <param name="y">description</param>
            <seealso cref="description" />
        </constructor>

</snip>