1 * Class Library Documentation
5 While using inline XML tags to document classes is certainly
6 convenient, properly verbose documentation quickly overwhelms
7 the code, making the source quite difficult to read. Furthermore,
8 multilingual documentation makes for significant additional text.
10 With these considerations in mind, Mono will use external XML files
11 for type documentation, rather than documenting the source
12 inline. The XML file format used is inspired by the XML format used
13 to document the ECMA APIs.
15 Several tools will be created for managing, verifying, generating,
16 and updating class library documentation, including:
19 <li><a href="#monodoc">monodoc - A graphical documentation viewer.</a></li>
20 <li>xmllint: a tool used to validate a proper XML document.
23 You can download the tools to document Mono from the CVS
24 repository from module `monodoc'.
26 ** Documentation Tools
28 *** <a name="monodoc">MonoDoc</a>
30 A graphical documentation viewer written in Gtk#. In the
31 future we will have an ASP.NET front-end to present the
32 documentation on the web as well.
38 Help us develop Mono's documentation tools! Subscribe to
39 <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>