Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mono/mono.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel de Icaza <miguel@gnome.org>2003-12-03 18:51:40 +0300
committerMiguel de Icaza <miguel@gnome.org>2003-12-03 18:51:40 +0300
commitba464c93f2f1737b9abd76c8b1b545043e3d5a11 (patch)
treed4a67c2453162dfe9b83f0bcec5512a9b690d1d2 /web/classlib-doc
parentaa3265e3eede34612ccd1e48ee7ff1999a4c6baa (diff)
Flush
svn path=/trunk/mono/; revision=20742
Diffstat (limited to 'web/classlib-doc')
-rw-r--r--web/classlib-doc26
1 files changed, 15 insertions, 11 deletions
diff --git a/web/classlib-doc b/web/classlib-doc
index 5b2c0547c2a..872b92c4ec1 100644
--- a/web/classlib-doc
+++ b/web/classlib-doc
@@ -7,22 +7,22 @@
the code, making the source quite difficult to read. Furthermore,
multilingual documentation makes for significant additional text.
- With these considerations in mind, Mono will use external XML files
- for type documentation, rather than documenting the source
+ With these considerations in mind, Mono is using external XML files
+ for class documentation, rather than documenting the source
inline. The XML file format used is inspired by the XML format used
to document the ECMA APIs.
- Several tools will be created for managing, verifying, generating,
- and updating class library documentation, including:
-
- <ul>
- <li><a href="#monodoc">monodoc - A graphical documentation viewer.</a></li>
+ Several tools exist for managing, verifying, generating,
+ and updating class library documentation.
- <li>xmllint: a tool used to validate a proper XML document.
- </ul>
+ The documentation infrastructure is part of the `Monodoc'
+ module. Monodoc includes a graphical GUI browser and tools to
+ generate the initial stubbed XML document out of an assembly.
+
+ Download `monodoc' to start producing documentation for your
+ application.
- You can download the tools to document Mono from the CVS
- repository from module `monodoc'.
+ For instructions, read the monodoc/README file.
** Documentation Tools
@@ -43,3 +43,7 @@
Help us develop Mono's documentation tools! Subscribe to
<a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>
and wade right in.
+
+ Monodoc today also supports a GUI-based collaborative editing
+ system. You can now edit the documentation from the browser
+ and upload your contributions directly to the Mono site.