2002-04-12 Duncan Mak <duncan@ximian.com>
[mono.git] / doc / classlib-doc
index 49735af98b158feeec6444346c370b3b3789f8a5..14fdc9e71911bce6f37cd49aa5849c49fc9e3daa 100644 (file)
@@ -29,7 +29,7 @@
 ** XML Documentation Files and Formats
 
        
-       *** Monodoc XML
+*** Monodoc XML
        This XML is similar to the XML documentation described in the
        C# standard, with added tags for internationalization and a
        slightly different structure.  Documentation and a DTD/Schema
@@ -41,7 +41,7 @@
        
        This XML could be generated by hand, by monostub, or by monodoc.
        
-       *** Assembly XML
+*** Assembly XML
        This XML is generated by combining runtime type information for
        an Assembly with a collection of Monodoc XML files.  The resultant
        XML (in the best of cases) contains both complete type and
        
 ** Documentation Tools
 
-       *** <a name="docstub">docstub</a>
+*** <a name="docstub">docstub</a>
        Given a type name and an assembly, generates stub Monodoc XML
        documentation for the type.  Optionally, docstub can attempt to
        populate initial documentation from an XML file in the format
        published along with the ECMA standard.
        
-       *** <a name="docverify">docverify</a>
+*** <a name="docverify">docverify</a>
        Given a Monodoc XML file and an assembly, verifies that the
        documentation matches the compiled type.  Checks signatures,
        parameters, et cetera.
        
-       *** <a name="docconv">docconv</a>
+*** <a name="docconv">docconv</a>
        Converts from Monodoc XML to the standard C# compiler-emitted
        XML format and vice versa.
        
-       *** <a name="docgen">docgen</a>
+*** <a name="docgen">docgen</a>
        Given an assembly and a collection of Monodoc XML files, creates
        an Assembly XML file containing all documentation and type information
        available.  This output is suitable for transforming into user
        documentation.
        
-       *** <a name="monodoc">monodoc</a>
+*** <a name="monodoc">monodoc</a>
        A GUI tool for documentation and translation, this encapsulates
        the capabilities of docstub, docverify, docconv, and docgen in
        a friendly user interface.  In addition, monodoc provides features
 
        Help us define Mono's documentation structure!  Subscribe to
        <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>
-       and wade right in.
\ No newline at end of file
+       and wade right in.