mcs/tools/monodoc/ChangeLog

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