grammar updates

[mono.git] / doc / classlib-doc

diff --git a/doc/classlib-doc b/doc/classlib-doc
index 19f92d6dfcfa0599586c0cf00223548a9eab4fda..5b2c0547c2a0bc7c09d64fb5a15bcdd551511819 100644 (file)
--- a/doc/classlib-doc
+++ b/doc/classlib-doc
@@ -8,52 +8,35 @@
        multilingual documentation makes for significant additional text.
        
        With these considerations in mind, Mono will use external XML files
-       for type documentation, rather than documenting the source inline.
-       
+       for type documentation, rather than documenting the source
+       inline.  The XML file format used is inspired by the XML format used
+       to document the ECMA APIs.  
+
        Several tools will be created for managing, verifying, generating,
        and updating class library documentation, including:
        
        <ul>
-               <li><a href="#monodoc">MonoDoc - A graphical documentation editor and viewer.</a></li>
-               <li><a href="#mkmaster">MkMaster - A command line tool to feed stub information to MonoDoc.</a></li>
-               <li><a href="#aspnet">An ASP.NET documentation editor.</a></li>
-               <li><a href="#xsltool">An xsl tool to convert monodoc xml to html documentation.</a></li>
-       </ul>
-
-** XML Documentation Files and Formats
-
+               <li><a href="#monodoc">monodoc - A graphical documentation viewer.</a></li>
 
-*** Monodoc XML
-       This XML is Mono's documentation format. Documentation and a DTD/Schema
-       for Monodoc XML is located in cvs and can be found <a href="http://go-mono.org/monodoc.dtd">here</a>.
+               <li>xmllint: a tool used to validate a proper XML document.
+       </ul>
 
-       This XML could be generated by MonoDoc or the ASP.NET client.
+       You can download the tools to document Mono from the CVS
+       repository from module `monodoc'.
 
-       More about the XML format <a href="http://go-mono.org/monodoc-xml.html">here</a>.
 ** Documentation Tools
 
 *** <a name="monodoc">MonoDoc</a>
-        A graphical documentation editor and viewer.  Currently, MonoDoc
-        consists of a Qt# application and is in heavy development.
-
-*** <a name="mkmaster">MkMaster</a>
-       This tool creates the Master.xml file that MonoDoc uses as a reference
-       for documentation generation. This is a reflection engine that is used
-       to gather metadata from assemblies and create an xml representation.
-
-*** <a name="aspnet">ASP.NET</a>
-       This tool is planned.
-
-*** <a name="xsltool">An XSL converter</a>
-       This tool is planned.  If someone wants to step forward and adopt this
-       project, it would be very helpful ;)
 
-** Status and Roadmap
+       The MonoDoc system offers both a GUI client as well as a <a
+       href="http://www.go-mono.com:8080">Web-based interface</a> to
+       the documentation.
 
-***  16, September 2002
+       The GUI edition uses <a
+       href="http://gtk-sharp.sf.net">Gtk#</a> and the Web edition
+       uses Mono's ASP.NET implementation. 
 
-A preliminary version of MonoDoc is in Mono's cvs.  It is under heavy development.
-Once this is complete we will start documenting the API!
+       <img src="images/Screenshot-Monodoc.png">
 
 ** Get Involved