web/classlib-doc

   1 * Class Library Documentation
   2
   3 ** Summary
   4
   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.
   9
  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.
  14
  15         Several tools will be created for managing, verifying, generating,
  16         and updating class library documentation, including:
  17
  18         <ul>
  19                 <li><a href="#monodoc">monodoc - A graphical documentation viewer.</a></li>
  20
  21                 <li>xmllint: a tool used to validate a proper XML document.
  22         </ul>
  23
  24         You can download the tools to document Mono from the CVS
  25         repository from module `monodoc'.
  26
  27 ** Documentation Tools
  28
  29 *** <a name="monodoc">MonoDoc</a>
  30
  31         The MonoDoc system offers both a GUI client as well as a <a
  32         href="http://www.go-mono.com:8080">Web-based interface</a> to
  33         the documentation.
  34
  35         The GUI edition uses <a
  36         href="http://gtk-sharp.sf.net">Gtk#</a> and the Web edition
  37         uses Mono's ASP.NET implementation.
  38
  39         <img src="images/Screenshot-Monodoc.png">
  40
  41 ** Get Involved
  42
  43         Help us develop Mono's documentation tools!  Subscribe to
  44         <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>
  45         and wade right in.