diff options
author | Adam Treat <adam@mono-cvs.ximian.com> | 2002-09-17 06:10:46 +0400 |
---|---|---|
committer | Adam Treat <adam@mono-cvs.ximian.com> | 2002-09-17 06:10:46 +0400 |
commit | 74467c031a498c04be39a815cbca4c7ada47a7f6 (patch) | |
tree | 4d138062d404d8c26ab12412b81efcc75c729ecb /web/classlib-doc | |
parent | 3eeddbd69d9a3010af9646d6f49dd27280c2abb8 (diff) |
* Update on the mono documentation tools.
svn path=/trunk/mono/; revision=7546
Diffstat (limited to 'web/classlib-doc')
-rw-r--r-- | web/classlib-doc | 102 |
1 files changed, 32 insertions, 70 deletions
diff --git a/web/classlib-doc b/web/classlib-doc index 89849cb6172..19f92d6dfcf 100644 --- a/web/classlib-doc +++ b/web/classlib-doc @@ -14,87 +14,49 @@ and updating class library documentation, including: <ul> - <li><a href="#docstub">docstub</a></li> - <li><a href="#docverify">docverify</a></li> - <li><a href="#docconv">docconv</a></li> - <li><a href="#docgen">docgen</a></li> - <li><a href="#monodoc">monodoc</a></li> + <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 - + *** 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 - for Monodoc XML is forthcoming. - - Monodoc XML does not contain any definitive type information, - and is only useful in conjunction with the Type definition for - whatever is being documented. - - This XML could be generated by hand, by monostub, or by monodoc. - -*** 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 - documentary information for each type in the assembly. - - This XML contains enough information to be transformed into - user-accessible documentation. It is likely that scripts - will be created to generate reference docs as HTML and other - formats. - - Documentation and a DTD/Schema for Assembly XML is forthcoming. - + 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>. + + This XML could be generated by MonoDoc or the ASP.NET client. + + More about the XML format <a href="http://go-mono.org/monodoc-xml.html">here</a>. ** Documentation Tools -*** <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> - 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> - Converts from Monodoc XML to the standard C# compiler-emitted - XML format and vice versa. - -*** <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 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 - to ease translation, such as side-by-side editing and coverage - statistics. - +*** <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 -*** 2 January 2002 +*** 16, September 2002 - As I write the initial version of this document, very little has been - implemented. Currently, there is a: - - <ul> - <li>Preliminary version of the Monodoc XML format</li> - <li>Preliminary version of the docstub utility</li> - </ul> - - Here's hoping for frequent, productive updates. +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! ** Get Involved - Help us define Mono's documentation structure! Subscribe to + Help us develop Mono's documentation tools! Subscribe to <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a> and wade right in. |