classlib-doc 1.3 KB

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