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
path: root/web
diff options
context:
space:
mode:
authorMiguel de Icaza <miguel@gnome.org>2002-01-03 04:22:31 +0300
committerMiguel de Icaza <miguel@gnome.org>2002-01-03 04:22:31 +0300
commited0239040063ef73396b0c9db79a27999b2a7d58 (patch)
tree3ecce011d97e7d794a2241db5689f76eaae7ab50 /web
parent0d446f192a5d7e9389c5f17c64637aaa709c882b (diff)
Integrate class lib docs
svn path=/trunk/mono/; revision=1784
Diffstat (limited to 'web')
-rw-r--r--web/classlib-doc16
-rw-r--r--web/documentation19
-rw-r--r--web/web/commands1
3 files changed, 11 insertions, 25 deletions
diff --git a/web/classlib-doc b/web/classlib-doc
index 49735af98b1..14fdc9e7191 100644
--- a/web/classlib-doc
+++ b/web/classlib-doc
@@ -29,7 +29,7 @@
** XML Documentation Files and Formats
- *** Monodoc XML
+*** Monodoc XML
This XML is similar to the XML documentation described in the
C# standard, with added tags for internationalization and a
slightly different structure. Documentation and a DTD/Schema
@@ -41,7 +41,7 @@
This XML could be generated by hand, by monostub, or by monodoc.
- *** Assembly XML
+*** Assembly XML
This XML is generated by combining runtime type information for
an Assembly with a collection of Monodoc XML files. The resultant
XML (in the best of cases) contains both complete type and
@@ -56,28 +56,28 @@
** Documentation Tools
- *** <a name="docstub">docstub</a>
+*** <a name="docstub">docstub</a>
Given a type name and an assembly, generates stub Monodoc XML
documentation for the type. Optionally, docstub can attempt to
populate initial documentation from an XML file in the format
published along with the ECMA standard.
- *** <a name="docverify">docverify</a>
+*** <a name="docverify">docverify</a>
Given a Monodoc XML file and an assembly, verifies that the
documentation matches the compiled type. Checks signatures,
parameters, et cetera.
- *** <a name="docconv">docconv</a>
+*** <a name="docconv">docconv</a>
Converts from Monodoc XML to the standard C# compiler-emitted
XML format and vice versa.
- *** <a name="docgen">docgen</a>
+*** <a name="docgen">docgen</a>
Given an assembly and a collection of Monodoc XML files, creates
an Assembly XML file containing all documentation and type information
available. This output is suitable for transforming into user
documentation.
- *** <a name="monodoc">monodoc</a>
+*** <a name="monodoc">monodoc</a>
A GUI tool for documentation and translation, this encapsulates
the capabilities of docstub, docverify, docconv, and docgen in
a friendly user interface. In addition, monodoc provides features
@@ -102,4 +102,4 @@
Help us define Mono's documentation structure! Subscribe to
<a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>
- and wade right in. \ No newline at end of file
+ and wade right in.
diff --git a/web/documentation b/web/documentation
index 166e0e8ccfe..fe3d61a8d25 100644
--- a/web/documentation
+++ b/web/documentation
@@ -31,20 +31,5 @@
** Class Library documentation
- When contributing to the Class Library effort, please use the
- inline XML documentation tags to document your classes so we
- can automatically generate the documentation from the class
- libraries.
-
- If you provide examples, please do not embed them into the
- source code, as that will make the source code harder to read
- and maintain. Instead, put examples for your code into a
- subdirectory of the class libraries. Make your sample
- code a full standalone application that people can compile.
- Ideally the Mono documentation browser will let you edit, modify
- and run the sample programs.
-
-
-
-
-
+ We are moving to a new setup for documenting the class libraries,
+ you can read about it <a href="classlib-doc.html">here</a> \ No newline at end of file
diff --git a/web/web/commands b/web/web/commands
index 999837acd76..f70c2fdcba3 100644
--- a/web/web/commands
+++ b/web/web/commands
@@ -12,6 +12,7 @@
1,AnonCVS access,anoncvs.html,anoncvs.src
0,Contributing,contributing.html,contributing.src
1,Documentation,documentation.html,documentation.src
+1,Class Docs,classlib-doc.html,classlib.src
1,Test Suite,testing.html,testing.src
1,Tools,tools.html,tools.src
1,Porting,porting.html,porting.src