1 * Class Library Documentation
6 [This documentation is in progress. Comments to
7 <a href="mailto:jbarn@httcb.net">jbarn@httcb.net</a>.]
10 While using inline XML tags to document classes is certainly
11 convenient, properly verbose documentation quickly overwhelms
12 the code, making the source quite difficult to read. Furthermore,
13 multilingual documentation makes for significant additional text.
15 With these considerations in mind, Mono will use external XML files
16 for type documentation, rather than documenting the source inline.
18 Several tools will be created for managing, verifying, generating,
19 and updating class library documentation, including:
22 <li><a href="#docstub">docstub</a></li>
23 <li><a href="#docverify">docverify</a></li>
24 <li><a href="#docconv">docconv</a></li>
25 <li><a href="#docgen">docgen</a></li>
26 <li><a href="#monodoc">monodoc</a></li>
29 ** XML Documentation Files and Formats
33 This XML is similar to the XML documentation described in the
34 C# standard, with added tags for internationalization and a
35 slightly different structure. Documentation and a DTD/Schema
36 for Monodoc XML is forthcoming.
38 Monodoc XML does not contain any definitive type information,
39 and is only useful in conjunction with the Type definition for
40 whatever is being documented.
42 This XML could be generated by hand, by monostub, or by monodoc.
45 This XML is generated by combining runtime type information for
46 an Assembly with a collection of Monodoc XML files. The resultant
47 XML (in the best of cases) contains both complete type and
48 documentary information for each type in the assembly.
50 This XML contains enough information to be transformed into
51 user-accessible documentation. It is likely that scripts
52 will be created to generate reference docs as HTML and other
55 Documentation and a DTD/Schema for Assembly XML is forthcoming.
57 ** Documentation Tools
59 *** <a name="docstub">docstub</a>
60 Given a type name and an assembly, generates stub Monodoc XML
61 documentation for the type. Optionally, docstub can attempt to
62 populate initial documentation from an XML file in the format
63 published along with the ECMA standard.
65 *** <a name="docverify">docverify</a>
66 Given a Monodoc XML file and an assembly, verifies that the
67 documentation matches the compiled type. Checks signatures,
68 parameters, et cetera.
70 *** <a name="docconv">docconv</a>
71 Converts from Monodoc XML to the standard C# compiler-emitted
72 XML format and vice versa.
74 *** <a name="docgen">docgen</a>
75 Given an assembly and a collection of Monodoc XML files, creates
76 an Assembly XML file containing all documentation and type information
77 available. This output is suitable for transforming into user
80 *** <a name="monodoc">monodoc</a>
81 A GUI tool for documentation and translation, this encapsulates
82 the capabilities of docstub, docverify, docconv, and docgen in
83 a friendly user interface. In addition, monodoc provides features
84 to ease translation, such as side-by-side editing and coverage
91 As I write the initial version of this document, very little has been
92 implemented. Currently, there is a:
95 <li>Preliminary version of the Monodoc XML format</li>
96 <li>Preliminary version of the docstub utility</li>
99 Here's hoping for frequent, productive updates.
103 Help us define Mono's documentation structure! Subscribe to
104 <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>