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 is using external XML files
  11         for class 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 exist for managing, verifying, generating,
  16         and updating class library documentation.
  17
  18         The documentation infrastructure is part of the `Monodoc'
  19         module.  Monodoc includes a graphical GUI browser and tools to
  20         generate the initial stubbed XML document out of an assembly.
  21
  22         Download `monodoc' to start producing documentation for your
  23         application.
  24
  25         For instructions, read the monodoc/README file.
  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.
  46
  47         Monodoc today also supports a GUI-based collaborative editing
  48         system.  You can now edit the documentation from the MonoDoc
  49         Browser and upload your contributions directly to the Mono site.