2009-01-06 Michael Barker <mike@middlesoft.co.uk>
[mono.git] / mcs / tools / monodoc / ChangeLog
1 2009-01-05  Jonathan Pryor  <jonpryor@vt.edu>
2
3         * Makefile: Fix $(the_lib) dependencies so that monodoc.dll is rebuilt
4           when one of Resources/* is modified.
5         * Resources/mdoc-html-utils.xsl: Rework the Requirements block so that
6           it doesn't require //AssemblyInfo or //AssemblyVersion.  This allows
7           `mdoc update -fno-assembly-versions ...`-produced XML to still
8           produce HTML with a Requirements section (skipping the Assembly
9           Versions block but generating the Namespace and Assembly blocks).
10           Change the behavior of //since generation so that instead of
11           printing out a note before the method summary, a Since block is added
12           to the Requirements section, and the Since block contains the
13           //since/@version text.  All this to make Mike Kestner happier. :-)
14
15 2008-10-29  Jonathan Pryor  <jonpryor@vt.edu>
16
17         * Monodoc/xhtml-provider.cs: Use HelpSource.Message(), not 
18           Console.WriteLine().
19
20 2008-10-28  Jonathan Pryor  <jonpryor@vt.edu>
21
22         * Monodoc/provider.cs: Add HelpSource.InlineCss and
23           HelpSource.InlineJavaScript virtual properties, so that the help
24           source can provide specific CSS and JavaScript to be included into
25           the generated HTML document.  This is used by the ASP.NET front-end,
26           as it needs to insert the CSS & JavaScript separately (as it also
27           inserts its own CSS & JavaScript).
28         * Monodoc/ecma-provider.cs, Monodoc/ecmaspec-provider.cs,
29           Monodoc/error-provider.cs: Override InlineCss & InlineJavaScript, as
30           appropriate.
31
32 2008-10-24  Jonathan Pryor  <jonpryor@vt.edu>
33
34         * Monodoc/addins-provider.cs, Monodoc/ecma-provider.cs,
35           Monodoc/ecmaspec-provider.cs, Monodoc/error-provider.cs,
36           Monodoc/man-provider.cs, Monodoc/monohb-provider.cs,
37           Monodoc/provider.cs: Remove Console.WriteLine() spew; helps cleanup
38           `make` output in mcs/docs (from `mdoc assemble`, which indirectly
39           invokes most of the *-provider files).  We solve this problem by
40           providing a TraceLevel-based message system, so that messages are
41           only generated if they are less than or equal to the requested
42           output level (thus skipping the more verbose "every file" messages
43           from ecma-provider.cs & error-provider.cs).
44         * provider.cs: Change Node.CompareTo() to use a "natural sorting"
45           algorithm -- this allows the C# Language Specification nodes to
46           continue being displayed in the correct order.
47
48 2008-10-21  Jonathan Pryor  <jonpryor@vt.edu>
49
50         * Monodoc/provider.cs: 
51           - Fix Node.Sort() so that it doesn't NRE if nodes == null.
52           - Fix Node.CompareTo() so that it can sort Nodes that haven't been
53             loaded yet.
54           - Add "libraries" as an alias for "root", so that .source files can
55             refer to the parent "libraries" (which would allow us to change
56             the location of "libraries" in the future, should we want to).
57           - If a /monodoc/source/@path refers to a nonexistant node, then
58             insert the contents under Various instead of ignoring it.
59           - Sort the top-level nodes.
60           - Sort the `parent` node after inserting children under it.  This
61             allows multiple different .source files to insert nodes under the
62             same parent node and still have the child nodes sorted as most
63             mortals would expect.
64           - Support a //node/@parent attribute, which allows for creating
65             nodes underneath the specified parent node.  This allows multiple
66             different .source files to contribute to the tree and depend upon
67             each other.  Thus, instead of having a single monodoc.xml file
68             that needs to know the entire tree in advance, the entire tree can
69             be spread across multiple .source files and filled at runtime.
70
71 2008-10-18  Jonathan Pryor  <jonpryor@vt.edu>
72
73         * Makefile $(LIBRARY_PACKAGE): Set to `monodoc`, as we historically
74           have had a monodoc package (and thus should preserve it).
75
76 2008-10-17  Jonathan Pryor  <jonpryor@vt.edu>
77
78         * Makefile: Distribute monodoc.dll.config.in.
79
80 2008-10-17  Jonathan Pryor  <jonpryor@vt.edu>
81
82         * Makefile: Generate a monodoc.dll.config (installed by gacutil), so
83           that monodoc.dll can find the documentation sources.
84
85 2008-10-16  Jonathan Pryor  <jonpryor@vt.edu>
86
87         * Mono.Documentation/ManifestResourceResolver.cs, 
88           Mono.Documentation/XmlDocUtils.cs: Make types public so that they
89           can be used from ../mdoc/mdoc.exe.
90
91 2008-10-16  Jonathan Pryor  <jonpryor@vt.edu>
92
93         * Makefile: Update $(thisdir).
94
95 2008-10-16  Jonathan Pryor  <jonpryor@vt.edu>
96
97         * Assmbly/AssemblyInfo.cs: Change location of mono.snk (since the 
98           monodoc directory was moved from mcs/class to mcs/tools).
99
100 2008-10-16  Jonathan Pryor  <jonpryor@vt.edu>
101
102         * Makefile: Improve `make clean` support.
103
104 2008-10-16  Jonathan Pryor  <jonpryor@vt.edu>
105
106         * Makefile: Add EXTRA_DISTFILES; monodoc.dll should depend upon
107           Makefile (in case the /resource: lines change); shorten the .gif
108           resource names.
109
110 2008-10-16  Jonathan Pryor  <jonpryor@vt.edu>
111
112         * Test (svn:ignore): Ignore generated files.
113         * Makefile: Add tests for man-provider.
114
115 2008-10-16  Jonathan Pryor  <jonpryor@vt.edu>
116
117         * ChangeLog: Added/Started.
118         * Makefile: Added; build monodoc.dll.
119