diff options
author | Jonathan Pryor <jpryor@novell.com> | 2008-10-24 17:23:12 +0400 |
---|---|---|
committer | Jonathan Pryor <jpryor@novell.com> | 2008-10-24 17:23:12 +0400 |
commit | ec5641f20387a4b01d2ab292e71451c12202150a (patch) | |
tree | 60b606066e7164b72b7eee25cf5db6feb9438030 /mcs/docs | |
parent | 9e4fe4b68a06aedc2cea2f31d02d1880ded97496 (diff) |
* docs (svn:ignore): Ignore generated files.
* docs/lang-csharp.source: Added; combined .source file for the C#
language specification and error reference.
* docs/Makefile: Support lang-csharp.source, mono-file-formats.*, etc.
*.tree/*.zip should be rebuilt when Makefile is changed.
* docs/mono-file-formats.config, docs/mono-file-formats.source: Added;
moving file format documentation out from mono-tools.* so that it's
easier to find.
* docs/mono-tools.config: Move mdoc(5), mono-config(5) to
mono-file-formats.config.
* docs/mono-tools.source, docs/Mono.source, docs/netdocs.source,
docs/Novell.source, docs/nunit-docs.source: Add /monodoc/node
information so that the documentation is inserted into the correct
location.
* docs/monodoc.xml: Vastly simplify the default monodoc.xml as
structure can be/has been pushed out into the .source files. This
should help simplify the life of downstream packagers who wish to
add additional documentation to monodoc.
* docs/ecma334.source, docs/cs-errors.source: Remove (replaced with
lang-csharp.source).
* tools/monodoc/Monodoc/provider.cs:
- Fix Node.Sort() so that it doesn't NRE if nodes == null.
- Fix Node.CompareTo() so that it can sort Nodes that haven't been
loaded yet.
- Add "libraries" as an alias for "root", so that .source files can
refer to the parent "libraries" (which would allow us to change
the location of "libraries" in the future, should we want to).
- If a /monodoc/source/@path refers to a nonexistant node, then
insert the contents under Various instead of ignoring it.
- Sort the top-level nodes.
- Sort the `parent` node after inserting children under it. This
allows multiple different .source files to insert nodes under the
same parent node and still have the child nodes sorted as most
mortals would expect.
- Support a //node/@parent attribute, which allows for creating
nodes underneath the specified parent node. This allows multiple
different .source files to contribute to the tree and depend upon
each other. Thus, instead of having a single monodoc.xml file
that needs to know the entire tree in advance, the entire tree can
be spread across multiple .source files and filled at runtime.
svn path=/trunk/mcs/; revision=116935
Diffstat (limited to 'mcs/docs')
-rw-r--r-- | mcs/docs/Makefile | 26 | ||||
-rw-r--r-- | mcs/docs/Mono.source | 1 | ||||
-rw-r--r-- | mcs/docs/Novell.source | 1 | ||||
-rw-r--r-- | mcs/docs/cs-errors.source | 4 | ||||
-rw-r--r-- | mcs/docs/ecma334.source | 4 | ||||
-rw-r--r-- | mcs/docs/lang-csharp.source | 9 | ||||
-rw-r--r-- | mcs/docs/mono-file-formats.config | 5 | ||||
-rw-r--r-- | mcs/docs/mono-file-formats.source | 5 | ||||
-rw-r--r-- | mcs/docs/mono-tools.config | 2 | ||||
-rw-r--r-- | mcs/docs/mono-tools.source | 1 | ||||
-rw-r--r-- | mcs/docs/monodoc.xml | 27 | ||||
-rw-r--r-- | mcs/docs/netdocs.source | 1 | ||||
-rw-r--r-- | mcs/docs/nunit-docs.source | 1 |
13 files changed, 44 insertions, 43 deletions
diff --git a/mcs/docs/Makefile b/mcs/docs/Makefile index ef8e1201116..9dc8b84b920 100644 --- a/mcs/docs/Makefile +++ b/mcs/docs/Makefile @@ -15,9 +15,9 @@ DISTFILES = \ $(wildcard ecma334/*.xml) DOC_SOURCE_FILES = \ - cs-errors.source \ - ecma334.source \ + lang-csharp.source \ mono-tools.source \ + mono-file-formats.source \ Mono.source \ netdocs.source \ Novell.source \ @@ -27,6 +27,7 @@ ASSEMBLED_DOCS = \ cs-errors.tree cs-errors.zip \ ecma334.tree ecma334.zip \ mono-tools.tree mono-tools.zip \ + mono-file-formats.tree mono-file-formats.zip \ Mono.tree Mono.zip \ netdocs.tree netdocs.zip \ Novell.tree Novell.zip \ @@ -96,24 +97,27 @@ NUNIT_DIRS = \ build-documentation: $(ASSEMBLED_DOCS) -netdocs.tree netdocs.zip: +netdocs.tree netdocs.zip: Makefile $(MDOC) assemble -o netdocs $(NETDOCS_DIRS) -Mono.tree Mono.zip: +Mono.tree Mono.zip: Makefile $(MDOC) assemble -o Mono $(MONO_DIRS) -Novell.tree Novell.zip: +Novell.tree Novell.zip: Makefile $(MDOC) assemble -o Novell $(NOVELL_DIRS) -nunit-docs.tree nunit-docs.zip: +nunit-docs.tree nunit-docs.zip: Makefile $(MDOC) assemble -o nunit-docs $(NUNIT_DIRS) -cs-errors.tree cs-errors.zip: - $(MDOC) assemble -o cs-errors -f error cs-errors.config +cs-errors.tree cs-errors.zip: cs-errors.config Makefile + $(MDOC) assemble -o cs-errors -f error $< -ecma334.tree ecma334.zip: +ecma334.tree ecma334.zip: Makefile $(MDOC) assemble -o ecma334 -f ecmaspec ecma334 -mono-tools.tree mono-tools.zip: mono-tools.config - $(MDOC) assemble -o mono-tools -f man mono-tools.config +mono-tools.tree mono-tools.zip: mono-tools.config Makefile + $(MDOC) assemble -o mono-tools -f man $< + +mono-file-formats.tree mono-file-formats.zip: mono-file-formats.config Makefile + $(MDOC) assemble -o mono-file-formats -f man $< diff --git a/mcs/docs/Mono.source b/mcs/docs/Mono.source index 6b318eded86..a61659555c1 100644 --- a/mcs/docs/Mono.source +++ b/mcs/docs/Mono.source @@ -1,4 +1,5 @@ <?xml version="1.0"?> <monodoc> + <node label="Mono Libraries" name="classlib-mono" parent="libraries" /> <source provider="ecma" basefile="Mono" path="classlib-mono"/> </monodoc> diff --git a/mcs/docs/Novell.source b/mcs/docs/Novell.source index 18bc57c92e4..509d06ac2c3 100644 --- a/mcs/docs/Novell.source +++ b/mcs/docs/Novell.source @@ -1,4 +1,5 @@ <?xml version="1.0"?> <monodoc> + <node label="Novell Libraries" name="classlib-novell" parent="libraries" /> <source provider="ecma" basefile="Novell" path="classlib-novell"/> </monodoc> diff --git a/mcs/docs/cs-errors.source b/mcs/docs/cs-errors.source deleted file mode 100644 index 598832b05e9..00000000000 --- a/mcs/docs/cs-errors.source +++ /dev/null @@ -1,4 +0,0 @@ -<?xml version="1.0"?> -<monodoc> - <source provider="error" basefile="cs-errors" path="cs-errors"/> -</monodoc> diff --git a/mcs/docs/ecma334.source b/mcs/docs/ecma334.source deleted file mode 100644 index 721a7489e1b..00000000000 --- a/mcs/docs/ecma334.source +++ /dev/null @@ -1,4 +0,0 @@ -<?xml version="1.0"?> -<monodoc> - <source provider="ecmaspec" basefile="ecma334" path="ecmaspec"/> -</monodoc> diff --git a/mcs/docs/lang-csharp.source b/mcs/docs/lang-csharp.source new file mode 100644 index 00000000000..9b49c4f9421 --- /dev/null +++ b/mcs/docs/lang-csharp.source @@ -0,0 +1,9 @@ +<?xml version="1.0"?> +<monodoc> + <node label="C#" name="lang-c#" parent="languages"> + <node label="C# Compiler Error Reference" name="cs-errors"/> + <node label="C# Language Specification" name="ecmaspec"/> + </node> + <source provider="error" basefile="cs-errors" path="cs-errors"/> + <source provider="ecmaspec" basefile="ecma334" path="ecmaspec"/> +</monodoc> diff --git a/mcs/docs/mono-file-formats.config b/mcs/docs/mono-file-formats.config new file mode 100644 index 00000000000..acb59b2c341 --- /dev/null +++ b/mcs/docs/mono-file-formats.config @@ -0,0 +1,5 @@ +<?xml version="1.0"?> +<manpages> + <manpage name="mdoc(5)" page="../../mono/man/mdoc.5" /> + <manpage name="mono-config(5)" page="../../mono/man/mono-config.5" /> +</manpages> diff --git a/mcs/docs/mono-file-formats.source b/mcs/docs/mono-file-formats.source new file mode 100644 index 00000000000..40d94f9e824 --- /dev/null +++ b/mcs/docs/mono-file-formats.source @@ -0,0 +1,5 @@ +<?xml version="1.0"?> +<monodoc> + <node label="Mono File Formats" name="mono-formats" parent="formats" /> + <source provider="man" basefile="mono-file-formats" path="mono-formats"/> +</monodoc> diff --git a/mcs/docs/mono-tools.config b/mcs/docs/mono-tools.config index ed8784cd31b..4b97722d7b7 100644 --- a/mcs/docs/mono-tools.config +++ b/mcs/docs/mono-tools.config @@ -20,7 +20,6 @@ <manpage name="mdcs2ecma(1)" page="../../mono/man/mdcs2ecma.1" /> <manpage name="mdnormalizer(1)" page="../../mono/man/mdnormalizer.1" /> <manpage name="mdoc(1)" page="../../mono/man/mdoc.1" /> - <manpage name="mdoc(5)" page="../../mono/man/mdoc.5" /> <manpage name="mdoc-assemble(1)" page="../../mono/man/mdoc-assemble.1" /> <manpage name="mdoc-export-html(1)" page="../../mono/man/mdoc-export-html.1" /> <manpage name="mdoc-export-msxdoc(1)" page="../../mono/man/mdoc-export-msxdoc.1" /> @@ -29,7 +28,6 @@ <manpage name="mdvalidator(1)" page="../../mono/man/mdvalidator.1" /> <manpage name="mkbundle(1)" page="../../mono/man/mkbundle.1" /> <manpage name="mono(1)" page="../../mono/man/mono.1" /> - <manpage name="mono-config(5)" page="../../mono/man/mono-config.5" /> <manpage name="mono-service(1)" page="../../mono/man/mono-service.1" /> <manpage name="mono-shlib-cop(1)" page="../../mono/man/mono-shlib-cop.1" /> <manpage name="monodocer(1)" page="../../mono/man/monodocer.1" /> diff --git a/mcs/docs/mono-tools.source b/mcs/docs/mono-tools.source index 0f6f9eb9a64..e545ef17a84 100644 --- a/mcs/docs/mono-tools.source +++ b/mcs/docs/mono-tools.source @@ -1,4 +1,5 @@ <?xml version="1.0"?> <monodoc> + <node label="Mono Development Tools" name="dev-tools" parent="tools" /> <source provider="man" basefile="mono-tools" path="dev-tools"/> </monodoc> diff --git a/mcs/docs/monodoc.xml b/mcs/docs/monodoc.xml index b9ad5c8360f..c31937d028b 100644 --- a/mcs/docs/monodoc.xml +++ b/mcs/docs/monodoc.xml @@ -1,24 +1,7 @@ <?xml version="1.0"?> -<node label="Mono Documentation" name="root:"> - <node label="Class Library" name="classlib"/> - <node label="Mono Libraries" name="classlib-mono"/> - <node label="Gnome Libraries" name="classlib-gnome"/> - <node label="Mozilla Libraries" name="classlib-gecko"/> - <node label="Novell Libraries" name="classlib-novell"/> - <node label="MonoDevelop IDE" name="md"> - <node label="API Reference" name="monodevelop" /> - <node label="Extension Point Reference" name="monodevelop-extension-guide" /> - </node> - <node label="Moonlight/Silverlight" name="moonlight"/> - <node label="C# Language Specification" name="ecmaspec" /> - <node label="C# Compiler Error Reference" name="cs-errors" /> - <node label="Mono Development Tools" name="dev-tools"> - <node label="Mono Debugger" name="debugger"/> - </node> - <node label="Mono Embedding" name="embed"/> - <node label="Various" name="various"> - <node label="DiaCanvas Libraries" name="classlib-diacanvas"/> - <node label="NUnit Libraries" name="classlib-nunit"/> - <node label="Tao" name="tao"/> - </node> +<node label="Mono Documentation" name="libraries"> + <node label="File Formats" name="formats" /> + <node label="Languages" name="languages" /> + <node label="Tools" name="tools" /> + <node label="Various" name="various" /> </node> diff --git a/mcs/docs/netdocs.source b/mcs/docs/netdocs.source index 2c7895674b4..18da2a72e36 100644 --- a/mcs/docs/netdocs.source +++ b/mcs/docs/netdocs.source @@ -1,4 +1,5 @@ <?xml version="1.0"?> <monodoc> + <node label="Base Class Library" name="classlib" parent="libraries" /> <source provider="ecma" basefile="netdocs" path="classlib"/> </monodoc> diff --git a/mcs/docs/nunit-docs.source b/mcs/docs/nunit-docs.source index c43e9b276cd..8ba041c0b83 100644 --- a/mcs/docs/nunit-docs.source +++ b/mcs/docs/nunit-docs.source @@ -1,4 +1,5 @@ <?xml version="1.0"?> <monodoc> + <node label="NUnit Libraries" name="classlib-nunit" parent="libraries" /> <source provider="ecma" basefile="nunit-docs" path="classlib-nunit"/> </monodoc> |