X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=blobdiff_plain;f=doc%2Fclasslib-doc;h=14fdc9e71911bce6f37cd49aa5849c49fc9e3daa;hb=0fda2aa47a3a299e865dc057c67db2734e611c3f;hp=49735af98b158feeec6444346c370b3b3789f8a5;hpb=0d446f192a5d7e9389c5f17c64637aaa709c882b;p=mono.git diff --git a/doc/classlib-doc b/doc/classlib-doc index 49735af98b1..14fdc9e7191 100644 --- a/doc/classlib-doc +++ b/doc/classlib-doc @@ -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 @@ -56,28 +56,28 @@ ** Documentation Tools - *** docstub +*** docstub 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. - *** docverify +*** docverify Given a Monodoc XML file and an assembly, verifies that the documentation matches the compiled type. Checks signatures, parameters, et cetera. - *** docconv +*** docconv Converts from Monodoc XML to the standard C# compiler-emitted XML format and vice versa. - *** docgen +*** docgen 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. - *** monodoc +*** monodoc 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 @@ -102,4 +102,4 @@ Help us define Mono's documentation structure! Subscribe to mono-docs-list - and wade right in. \ No newline at end of file + and wade right in.