blob: 5b2c0547c2a0bc7c09d64fb5a15bcdd551511819 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
* Class Library Documentation
** Summary
While using inline XML tags to document classes is certainly
convenient, properly verbose documentation quickly overwhelms
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
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>
<li>xmllint: a tool used to validate a proper XML document.
</ul>
You can download the tools to document Mono from the CVS
repository from module `monodoc'.
** Documentation Tools
*** <a name="monodoc">MonoDoc</a>
The MonoDoc system offers both a GUI client as well as a <a
href="http://www.go-mono.com:8080">Web-based interface</a> to
the documentation.
The GUI edition uses <a
href="http://gtk-sharp.sf.net">Gtk#</a> and the Web edition
uses Mono's ASP.NET implementation.
<img src="images/Screenshot-Monodoc.png">
** Get Involved
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.
|
