1 2009-11-06 Jonathan Pryor <jpryor@novell.com>
3 * Mono.Documentation/monodocer.cs: When deleting the ExtensionMethods
4 element, remove it from the correct parent XML node. Fixes #553144.
6 2009-09-19 Jonathan Pryor <jpryor@novell.com>
8 * Mono.Documentation/monodocs2html.cs: Add --with-profile=PROFILE
9 option, which just provides a simple mapping between profile names
10 like net_3_5 to the versions used in that profile.
12 2009-09-19 Jonathan Pryor <jpryor@novell.com>
14 * Mono.Documentation/monodocs2html.cs: By request of Edd Dumbill, add
15 --with-version=VERSION option. This will generate HTML
16 documentation for ONLY those types/members which exist within
17 VERSION. This makes it easy to generate HTML that will show e.g.
18 only MonoTouch docs (and not the full class library docs).
19 * Makefile: Add test for 'mdoc export-html --with-version=VERSION'.
20 Somewhat brain-dead, as it only checks for added types (and not
21 added members), but better than nothing...
23 2009-09-09 Jonathan Pryor <jpryor@novell.com>
25 * Mono.Documentation/monodocs2html.cs: Fix behavior when multiple
26 source directories are provided, e.g. 'mdoc export-html -o o a b c'
27 with docs located in directories a, b, and c. Previously this would
28 be equivalent to running aginst a, b, and c separately, resulting in
29 o/index.html being continually overwritten (and thus not showing ALL
31 * Resources/stylesheet.xsl: Make $Index a parameter (as monodocs2html
32 will create an in-memory index containing all types from all
33 specified directories), and various changes to cope with $Index no
34 longer being a file. Better support files in the global namespace.
35 * Test/html.expected/NoNamespace.html: Fix assembly link.
37 2009-08-12 Jonathan Pryor <jpryor@novell.com>
39 * Test/DocTest-v1.cs: Add a comment which uses <format/>, to test html
41 * Resources/monodoc-ecma.xsd: Permit <format/> in various elements.
42 * Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
43 Test/html.expected/Mono.DocTest/DocAttribute.html,
44 Test/msxdoc-expected.importslashdoc.xml: Flush.
46 2009-08-12 Jonathan Pryor <jpryor@novell.com>
48 * Makefile: Add ../monodoc/Resources/mdoc-html-format.xsl as a resource.
50 2009-08-06 Jonathan Pryor <jpryor@novell.com>
52 * mdoc.exe.sources: Add ../../build/common/Consts.cs to the build.
53 * Mono.Documentation/mdoc.cs: mdoc version is Consts.MonoVersion, not
54 some hard-coded, perpetually out-of-date version.
56 2009-08-02 Jonathan Pryor <jpryor@novell.com>
58 * Mono.Documentation/monodocer.cs: Sometimes <AssemblyVersion/> is
59 found twice when it's actually present only once (!). Attempt to
60 work around this by usinq LINQ instead of a foreach (which oddly
63 2009-07-31 Jonathan Pryor <jpryor@novell.com>
65 * Mono.Documentation/monodocer.cs: Record attributes that are placed
66 on property get/set and event add/remove accessors.
67 * Test/DocTest-v1.cs: Add attributes to some accessors.
68 * Test/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
69 Test/en.expected.since/Mono.DocTest/Widget.xml,
70 Test/en.expected/Mono.DocTest/Widget.xml,
71 Test/html.expected/Mono.DocTest/Widget.html,
72 Test/msxdoc-expected.importslashdoc.xml: Flush.
74 2009-06-23 Jonathan Pryor <jpryor@novell.com>
76 * Mono.Documentation/monodocer.cs: Don't generate an exception when an
77 enumeration contains multiple names with the same value.
79 * Test/DocTest-v1.cs: Add test for #515030.
80 * Test/en.expected/Mono.DocTest/Color.xml,
81 Test/en.expected.since/Mono.DocTest/Color.xml,
82 Test/html.expected/Mono.DocTest/Color.html,
83 Test/msxdoc-expected.importslashdoc.xml,
84 Test/en.expected.importslashdoc/Mono.DocTest/Color.xml: Flush.
86 2009-04-18 Jonathan Pryor <jpryor@novell.com>
88 * Mono.Documentation/webdoc.cs: Change -o semantics to be a directory
89 prefix, e.g. `mdoc export-html-webdoc -o cache.new foo.tree` will
90 output files into `cache.new/foo` instead of directly into
91 `cache.new`. This makes it easier to specify more than one
92 .tree/.zip file on the command line.
94 2009-04-16 Jonathan Pryor <jpryor@novell.com>
96 * Mono.Documentation/monodocs2slashdoc.cs: Code refactor; use
97 EcmaDoc.GetCref() to generate //member/@name values.
98 * Mono.Documentation/dump.cs: Add -f=FORMAT support, so that we can
99 load an appropriate HelpSource (if supplied) so that an appropriate
100 Node.PublicUrl can be displayed in the output.
102 2009-04-15 Jonathan Pryor <jpryor@novell.com>
104 * Mono.Documentation/webdoc.cs: Remove console debug spew. If you run
105 with `mdoc -v`, each URL will be printed as it's processed.
107 2009-04-15 Jonathan Pryor <jpryor@novell.com>
109 * Mono.Documentation/webdoc.cs: When extracting files from the .zip
110 file, ensure that the output file is closed. Properly pre-render
111 ecma namespace documentation.
113 2009-04-15 Jonathan Pryor <jpryor@novell.com>
115 * Makefile: Add reference to ICSharpCode.SharpZipLib.dll.
116 * mdoc.exe.sources: Add Mono.Rocks/ObjectRocks.cs,
117 Mono.Rocks/StreamRocks.cs.
118 * Mono.Documentation/webdoc.cs: Refactor into smaller methods. Extract
119 ZIP file contents in addition to generating HTML output. Use
120 monodoc helper methods to determine cache directory.
121 * Mono.Documentation/ObjectRocks.cs: Rename to
122 Mono.Rocks/ObjectRocks.cs.
123 * Mono.Rocks/ObjectRocks.cs: Add Check.Destination().
124 * Mono.Rocks/StreamRocks.cs: Added; extension methods for Streams.
126 2009-04-15 Jonathan Pryor <jpryor@novell.com>
128 * Mono.Documentation/webdoc.cs: The timestamp logic was wrong it the
129 output directory didn't exist. Fix.
131 2009-04-15 Jonathan Pryor <jpryor@novell.com>
133 * Mono.Documentation/webdoc.cs: Do as make(1) does: if the
134 target directory already exists and is newer than the source files,
135 don't regenerate output. (Greatly speeds things up if nothing has
136 changed.) Add a --force-update option to disable this behavior.
138 2009-04-15 Jonathan Pryor <jpryor@novell.com>
140 * Mono.Documentation/webdoc.cs: Change the default -o value to
141 include a "cache" intermediate directory. This makes it easier to
142 kill the entire cache at once.
144 2009-04-15 Jonathan Pryor <jpryor@novell.com>
146 * Mono.Documentation/webdoc.cs: Provide nice default -o value.
148 2009-04-15 Jonathan Pryor <jpryor@novell.com>
150 * Mono.Documentation/webdoc.cs: Load documentation through a
151 HelpSource, not through the RootTree, as URLs of the form
152 "ecma:0#AvoidExtensionMethodOnSystemObjectRule/" use the number (0
153 in this case) as a HelpSource-relative identifier. Result: you get
154 the wrong documentation if you go through RootTree.
156 2009-04-15 Jonathan Pryor <jpryor@novell.com>
158 * Makefile: Add reference to System.Web.dll, for HttpUtility.
159 * mdoc.exe.sources: Add ObjectRocks.cs, webdoc.cs to the build.
160 * Mono.Documentation/mdoc.cs: Add export-html-webdoc command, which
161 "pre-renders" HTML for use by the webdoc ASP.NET renderer.
162 * Mono.Documentation/webdoc.cs: Added; MDocExportWebdocHtml
163 implementation; attempts to pre-render HTML based on .tree/.zip
165 * Mono.Documentation/ObjectRocks.cs: Added; extension methods for tree
166 traversal (from Mono.Rocks). For use in webdoc.cs.
168 2009-04-09 Jonathan Pryor <jpryor@novell.com>
170 * Mono.Documentation/monodocer.cs: Using a single IAssemblyResolver is
171 an improvement, but doesn't fix all problems. In particular, some
172 assemblies will depend upon other assemblies to load (e.g. 3rd party
173 assemblies) but these dependent assemblies shouldn't be documented.
174 Add support for -r:ASSEMBLY and -L:DIRECTORY arguments to allow the
175 user to manually add to the assembly search path so that assemblies
176 can be found. Assemblies added via -r will NOT be documented.
178 2009-04-08 Jonathan Pryor <jpryor@novell.com>
180 * Mono.Documentation/monodocer.cs: Use a single IAssemblyResolver
181 shared amongst all AssemblyDefinitions to resolve assembly/type
182 references with Cecil. Otherwise, if we have deeply nested
183 directories with cross-directory assembly dependencies, then Cecil
184 won't find the necessary assemblies (e.g. b/bin/Debug/b.dll has a
185 type which inherits from a/bin/Debug/a.dll -- here, we'll have two
186 separate AssemblyDefinitions, and when b.dll's AssemblyDefinition
187 tries to resolve types from a.dll, it fails).
188 See: http://lists.ximian.com/pipermail/mono-devel-list/2009-April/031646.html
190 2009-03-29 Jonathan Pryor <jpryor@novell.com>
192 * Mono.Documentation/exceptions.cs: Add
193 ExceptionLocations.AddedMember, used for --exceptions=added support.
194 * Mono.Documentation/monodocer.cs: Add --exceptions=added, which will
195 only add <exception/> elements for newly added elements. This is
196 useful for updating documentation for established projects which
197 already have <exception/> corrections (e.g. *removal* of
198 <exception/> elements because the exceptions weren't actually
199 possible), so only new members should have <exception/> created.
201 2009-03-20 Jonathan Pryor <jpryor@novell.com>
203 * Mono.Documentation/monodocs2html.cs: Perform the timestamp check for
204 the top-level and namespace-level index files.
206 2009-03-21 Jonathan Pryor <jpryor@novell.com>
208 * Mono.Documentation/monodocer.cs: Be nice to make,
209 mdoc-export-html, and other apps that use file timetamps: if the
210 file contents haven't changed after the update, don't replace the
211 "original" file. This preserves file timestamps, thus allowing
212 other apps to behave nicely (e.g. mdoc-export-html won't update all
213 documentation after running mdoc-update, as the files won't change
214 unless something has *actually* changed).
216 2009-03-20 Jonathan Pryor <jpryor@novell.com>
218 * Mono.Documentation/monodocs2html.cs: Do as make(1) does: if the
219 target file already exists and is newer than the source file, don't
220 regenerate it. (Greatly speeds things up if only a few .xml files
221 changed.) Add a --force-update option to disable this behavior.
223 2009-02-26 Jonathan Pryor <jpryor@novell.com>
225 * Mono.Documentation/assembler.cs: When processing an empty directory,
226 it's possible for HelpSource.Tree to be null; avoid an NRE.
228 2009-02-17 Jonathan Pryor <jpryor@novell.com>
230 * Test/DocTest-v1.cs: Add test for #475814.
231 * Mono.Documentation/exceptions.cs, Mono.Documentation/monodocer.cs:
232 Use the new Mono.Cecil .Resolve() methods instead of (erroneously)
233 duplicating their functionality with the .GetDefinition() methods.
234 ExceptionLookup.this[IMemberReference] checks for multi-dimensional
235 arrays, as MD arrays are "special" (Cecil can't resolve them, as
236 they're internal to the runtime with no specific associated IL).
239 2009-02-17 Jonathan Pryor <jpryor@novell.com>
241 * Mono.Documentation/monodocer.cs: Check that the cref attribute is
242 non-null before trying to use it when importing slashdoc sources.
244 * Test/DocTest-v1.cs: Add an <exception/> doc comment with an invalid
245 attribute value for testing.
247 2009-02-17 Jonathan Pryor <jpryor@novell.com>
249 * Mono.Documentation/mdoc.cs: Set Environment.ExitCode=1 if an
250 exception occurs, so that calling code can determine that an error
251 occurred w/o resorting to parsing stderr. Fixes #475746.
253 2009-02-16 Jonathan Pryor <jpryor@novell.com>
255 * Mono.Documentation/monodocer.cs: Support C#4 variant generics, e.g.
256 `delegate TRet Func<in TArg, out TRet>(TArg a)'. Alas, this
257 required making MemberFormatter explicitly stateful, so any thoughts
258 of using instances w/o locking are now out the window... (Not that
259 threads are currently used, but they're planned to be used...)
260 TODO: Add a test to Test/DocTest-v1.cs. This wasn't done as the
261 current gmcs support doesn't like intermixing variance with generic
262 parameter attributes, and I don't want to introduce a new delegate
263 type (and the ~6 new files that would imply) just for this feature.
265 2009-02-10 Jonathan Pryor <jpryor@novell.com>
267 * Mono.Documentation/monodocer.cs: Cleanup: turn static data into
268 instance data (for future Threading changes, as only static data
269 will be tracked for thread-safety); use MDocCommand.Message() and
270 MDocCommand.Error() for message reporting; remove warnings.
272 2009-01-05 Jonathan Pryor <jpryor@novell.com>
274 * Makefile: Fix $(PROGRAM) dependencies so that mdoc.exe is rebuilt
275 when one of the dependent ../monodoc/Resources/* files is changed.
277 2009-01-05 Jonathan Pryor <jpryor@novell.com>
279 * Mono.Documentation/mdoc.cs: `mdoc' (no arguments) shouldn't print an
280 index out of range error. Fix.
281 * Mono.Documentation/monodocer.cs: Rename -fno-member-assembly-info to
282 -fno-assembly-versions, which prevents generation of //AssemblyVersion
283 elements. This suffers the same warning as -fno-member-assembly-info,
284 so don't use unless you can guarantee that no members will
285 ever be removed from your public API. :-)
286 Clean up -f handling so that -f:no-assembly-versions will work as
289 2009-01-05 Jonathan Pryor <jpryor@novell.com>
291 * Mono.Documentation/monodocer.cs: Add -fno-member-assembly-info,
292 which remove /Type/Members/Member/AssemblyInfo elements.
293 Requested by Mike Kestner.
294 Warning: this option will break automatic version tracking, so if a
295 member is present in e.g. v1.0 and is removed in e.g. v2.0,
296 the //Member element will be removed entirely when updating the
297 documentation against the 2.0 assembly. Use with care.
299 2008-12-06 Jonathan Pryor <jpryor@novell.com>
301 * Mono.Documentation/monodocer.cs: Remove "exception" from DocsNodeOrder
302 so that <exception/> elements aren't grouped together. This causes
303 `make doc-update` to result in ~0 changes in ../../class/corlib.
304 Change the sorting of --exceptions-generated <exception/> nodes so
305 that namespaces are taken into consideration, thus "properly"
306 grouping types by namespaces, as I'd usually expect...
308 2008-12-05 Jonathan Pryor <jpryor@novell.com>
310 * Mono.Documentation/monodocer.cs, Mono.Documentation/monodocs2html.cs:
311 Reorder parameters to be in sorted order, so `mdoc help COMMAND`
312 parameters are sorted.
313 * Mono.Documentation/monodocer.cs: Remove try/catch in
314 MDocUpdater.Run(MDocUpdaterOptions), so that any generated exceptions
315 will be handled within mdoc itself (thus allowing the normal
316 "See `mdoc help' for more information." message). Improve some
317 error messages so they're more useful.
319 2008-12-04 Jonathan Pryor <jpryor@novell.com>
321 * Makefile: Specify --exceptions=all in mdoc-update invocations.
322 * exceptions.cs: Add support for documenting a *subset* of all
323 possible exceptions. Subsets include: the member itself, the member
324 and methods it calls that are in the same assembly, and all possible
325 methods across all assemblies.
326 * monodocer.cs: Allow --exceptions to take a SOURCES argument, to
327 control which location sources will be searched for exceptions.
329 2008-12-02 Jonathan Pryor <jpryor@novell.com>
331 * Makefile: Add --exceptions to `mdoc update` invocations to test
332 <exception/> generation.
333 * mdoc.exe.sources: Add Mono.Documentation/exceptions.cs to the build.
334 * Mono.Documentation/exceptions.cs: Added; searches through the
335 callgraph of an IMemberReference, recording which exception types
336 are created (and where they're created from).
337 * Mono.Documentation/monodocer.cs: Generate <exception/> elements.
338 * Test/DocTest-v1.cs: Modify some methods so that exceptions are
339 emitted (thus testing <exception/> generation).
340 * Test/DocTest-v2.patch: Update (so patch(1) doesn't complain).
341 * Test/en.expected.importecmadoc/System/Array.xml,
342 Test/en.expected.importecmadoc/System/Environment.xml,
343 Test/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
344 Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
345 Test/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
346 Test/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
347 Test/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
348 Test/en.expected.importslashdoc/System/Array.xml,
349 Test/en.expected.importslashdoc/System/Environment.xml,
350 Test/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
351 Test/en.expected.since/Mono.DocTest/DocAttribute.xml,
352 Test/en.expected.since/Mono.DocTest/DocValueType.xml,
353 Test/en.expected.since/Mono.DocTest/UseLists.xml,
354 Test/en.expected.since/Mono.DocTest/Widget.xml,
355 Test/en.expected.since/System/Array.xml,
356 Test/en.expected.since/System/Environment.xml,
357 Test/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
358 Test/en.expected/Mono.DocTest/DocAttribute.xml,
359 Test/en.expected/Mono.DocTest/DocValueType.xml,
360 Test/en.expected/Mono.DocTest/UseLists.xml,
361 Test/en.expected/Mono.DocTest/Widget.xml,
362 Test/en.expected/System/Array.xml,
363 Test/en.expected/System/Environment.xml,
364 Test/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
365 Test/html.expected/Mono.DocTest/DocAttribute.html,
366 Test/html.expected/Mono.DocTest/DocValueType.html,
367 Test/html.expected/Mono.DocTest/UseLists.html,
368 Test/html.expected/Mono.DocTest/Widget.html,
369 Test/html.expected/System/Array.html,
370 Test/html.expected/System/Environment.html,
371 Test/msxdoc-expected.importslashdoc.xml: Flush; adds <exception/>
372 elements (and/or HTML-rendered output of <exception/> elements).
374 2008-11-19 Jonathan Pryor <jpryor@novell.com>
376 * Mono.Documentation/monodocer.cs: Add the assembly's directory to
377 Cecil's BaseAssemblyResolver search list so that assemblies in the
378 same directory as the assembly we're processing can be found.
379 Allows mono-tools/gendarme to be built with a Cecil-using mdoc.
381 2008-11-15 Jonathan Pryor <jpryor@novell.com>
383 * Mono.Documentation/monodocer.cs: Properties on interfaces shouldn't
384 have `abstract' on them.
385 * Test/DocTest-v1.cs: Add a property to an interface to check above.
386 * Test/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
387 Test/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
388 Test/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
389 Test/html.expected/Mono.DocTest/Widget+IMenuItem.html,
390 Test/msxdoc-expected.importslashdoc.xml: Flush.
392 2008-11-15 Jonathan Pryor <jpryor@novell.com>
394 * Mono.Documentation/monodocer.cs: Fix regressions found from
395 `make doc-update` in corlib:
396 - Ensure that custom attributes are sorted (they weren't before,
397 resulting in spurious differences between Reflection & Cecil
399 - CecilExtensions.GetMethod() should return null if the method can't
401 - DocUtils.IsDelegate() should ensure that the delegate type isn't
402 abstract (otherwise it dies on System.MulticastDelegate, which is
403 an abstract type lacking an "Invoke" method).
404 - Properly count generic argument counts for nested types (fixes IOE
405 from S.C.G.Dictionary`2.KeyCollection.Enumerator).
406 * Test/DocTest-v1.cs: Add doubly-nested class under a generic class to
407 simulate S.C.G.Dictionary`2.KeyCollection.Enumerator behavior.
408 * Test/en.expected.importslashdoc/index.xml,
409 Test/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1+NestedCollection+Enumerator.xml,
410 Test/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1+NestedCollection.xml,
411 Test/en.expected.since/index.xml,
412 Test/en.expected.since/Mono.DocTest.Generic/GenericBase`1+NestedCollection+Enumerator.xml,
413 Test/en.expected.since/Mono.DocTest.Generic/GenericBase`1+NestedCollection.xml,
414 Test/en.expected/index.xml,
415 Test/en.expected/Mono.DocTest.Generic/GenericBase`1+NestedCollection+Enumerator.xml,
416 Test/en.expected/Mono.DocTest.Generic/GenericBase`1+NestedCollection.xml,
417 Test/html.expected/index.html,
418 Test/html.expected/Mono.DocTest.Generic/GenericBase`1+NestedCollection+Enumerator.html,
419 Test/html.expected/Mono.DocTest.Generic/GenericBase`1+NestedCollection.html,
420 Test/html.expected/Mono.DocTest.Generic/index.html,
421 Test/msxdoc-expected.importslashdoc.xml: Flush (new types/changes
422 from DocTest-v1.cs changes).
425 2008-11-14 Jb Evain <jbevain@novell.com>
427 * Makefile: Use Mono.Cecil from class/lib/net_1_1, not net_2_0.
429 2008-11-14 Jonathan Pryor <jpryor@novell.com>
431 * Makefile: Don't build monodocer1.exe, and add Mono.Cecil.dll to the
432 list of assembly references for mdoc.exe.
433 * Mono.Documentation/monodocer.cs: Migrate from System.Reflection to
434 Mono.Cecil. This was done for two reasons:
435 1. mscorlib.dll: Reflection can load only one mscorlib.dll into an
436 AppDomain, which must be the same mscorlib.dll as the runtime
437 version. Thus, in order to run monodocer on mscorlib.dll v1.1,
438 monodocer must be a .NET 1.1 application, and to document
439 mscorlib.dll v2.0, monodocer must be a .net 2.0 app.
440 1.a I don't think it's feasable to drop support for
442 1.b This has been previously handled (so far) with conditional
443 compilation, but the conditional compilation is painful to
444 maintain, and prevents use of LINQ in ongoing development.
445 1.c .NET 4.0 will be coming out "soon" (within 2 years?), and it's
446 possible that mono will maintain the same limitation, thus
447 necessitating having *three* different monodocer programs to
448 document mscorlib.dll for v1.1, v2.0, and v4.0. Yech.
449 2. Future directions: It would be nice to parse method/property IL
450 bodies to determine which exceptions can be generated, thus
451 generating <exception cref="..."/> stubs. Even with empty stubs,
452 I belive this would be useful within e.g. MonoDevelop to know
453 which exceptions a method is able to generate.
454 This cannot be done (at present) with System.Reflection, and
455 would require Mono.Cecil.
456 Downsides: mdoc now depends upon Mono.Cecil, which is API-unstable.
457 This will likely also complicate execution under .NET, as Mono.Cecil
458 would need to be XCOPY deployed into mdoc.exe's directory.
459 * Test/DocTest-v1.cs: Add additional tests for Custom Attribute
461 * Test/en.expected.importslashdoc/Mono.DocTest.Generic/Func`2.xml,
462 Test/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
463 Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
464 Test/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml,
465 Test/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
466 Test/en.expected.since/Mono.DocTest.Generic/Func`2.xml,
467 Test/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
468 Test/en.expected.since/Mono.DocTest/DocAttribute.xml,
469 Test/en.expected.since/Mono.DocTest/Widget+Direction.xml,
470 Test/en.expected.since/Mono.DocTest/Widget.xml,
471 Test/en.expected/Mono.DocTest.Generic/Func`2.xml,
472 Test/en.expected/Mono.DocTest.Generic/MyList`2.xml,
473 Test/en.expected/Mono.DocTest/DocAttribute.xml,
474 Test/en.expected/Mono.DocTest/Widget+Direction.xml,
475 Test/en.expected/Mono.DocTest/Widget.xml,
476 Test/html.expected/Mono.DocTest.Generic/Func`2.html,
477 Test/html.expected/Mono.DocTest.Generic/MyList`2.html,
478 Test/html.expected/Mono.DocTest/DocAttribute.html,
479 Test/html.expected/Mono.DocTest/Widget+Direction.html,
480 Test/html.expected/Mono.DocTest/Widget.html,
481 Test/msxdoc-expected.importslashdoc.xml: Flush -- updated output due
482 to new custom attributes, better implemented interface detection --
483 care of the Mono.Cecil migration -- etc.
485 2008-11-13 Jonathan Pryor <jpryor@novell.com>
487 * Test/html.expected/**: Update
488 //meta[@http-equiv='Content-Type']/@content attribute value (changed
489 due to yesterday's defaulttemplate.xsl fix).
491 2008-11-12 Jonathan Pryor <jpryor@novell.com>
493 * Resources/defaulttemplate.xsl: Update /html/head/meta/@content value
494 so that IE7 properly recognizes the file as UTF-8 encoded.
497 2008-10-27 Jonathan Pryor <jpryor@novell.com>
499 * Makefile: Fix build error caused by filenames containing '`'.
501 2008-10-27 Jonathan Pryor <jpryor@novell.com>
503 * Mono.Documentation/mdoc.cs: TraceLevel.Error messages should go to
504 Console.Error, as per Unix convention.
505 * Makefile: cehck-mdoc-validate* needs to also capture standard error.
507 2008-10-27 Jonathan Pryor <jpryor@novell.com>
509 * Mono.Documentation/validate.cs: Remove warnings
510 * Test/validate.check.monodocer, Test/validate.check.monodocer.since:
511 Don't generate output if no errors are found.
512 * Test/validate.check.monodocer.importslashdoc: Prefix error messages
513 with "mdoc:", as per Unix convention.
515 2008-10-24 Jonathan Pryor <jpryor@novell.com>
517 * Makefile: Fixup mdoc.exe dependencies so that it's rebuilt if the
518 resources or monodoc.dll change. Add tests for mdoc-validate.
519 * Mono.Documentation/assembler.cs, Mono.Documentation/mdoc.cs,
520 Mono.Documentation/monodocer.cs, Mono.Documentation/monodocs2html.cs,
521 Mono.Documentation/monodocs2slashdoc.cs,
522 Mono.Documentation/validate.cs:
523 - Major rearchitecture; instead of having the option parsing
524 centralized within mdoc.cs, keep option parsing within the relevant
526 - Introduce the MDocCommand abstract class to serve as the base class
527 -- primarily done to introduce the new Message() and Error()
528 methods, in which Message() will only show the message if the
529 current message level is >= the message's level (thus minimizing
530 console spew); see ../monodoc for more details.
531 - Add `-v' ("verbose") top-level argument to allow setting/adding
532 levels, so that `mdoc -v -v assemble ...` will show *all*
533 assemble-associated messages (which can be quite voluminous).
534 - Remove compiler warnings, when able.
535 * Mono.Documentation/XhtmlWriter.cs: Remove warning about unused
537 * Resources/monodoc-ecma.xsd: Extend the XSD to support more
538 elements/attributes on various elements -- e.g. mdoc-update looks
539 for a //code/@src attribute, which wasn't defined in the XSD. Oops.
540 * Test/validate.check.monodocer.importslashdoc: Flush (due to above
543 2008-10-22 Jonathan Pryor <jpryor@novell.com>
545 * Makefile: Correct path names.
546 * Mono.Documentation/monodocer.cs: Better support nested types.
547 * Test/DocTest-v1.cs: Add 4 levels of nested types.
548 * Test/en.expected.importslashdoc/index.xml,
549 Test/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
550 Test/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass+Double+Triple+Quadruple.xml,
551 Test/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass+Double+Triple.xml,
552 Test/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass+Double.xml,
553 Test/en.expected.since/index.xml,
554 Test/en.expected.since/Mono.DocTest/Widget.xml,
555 Test/en.expected.since/Mono.DocTest/Widget+NestedClass+Double+Triple+Quadruple.xml,
556 Test/en.expected.since/Mono.DocTest/Widget+NestedClass+Double+Triple.xml,
557 Test/en.expected.since/Mono.DocTest/Widget+NestedClass+Double.xml,
558 Test/en.expected/index.xml,
559 Test/en.expected/Mono.DocTest/Widget.xml,
560 Test/en.expected/Mono.DocTest/Widget+NestedClass+Double+Triple+Quadruple.xml,
561 Test/en.expected/Mono.DocTest/Widget+NestedClass+Double+Triple.xml,
562 Test/en.expected/Mono.DocTest/Widget+NestedClass+Double.xml,
563 Test/html.expected/index.html,
564 Test/html.expected/Mono.DocTest/index.html,
565 Test/html.expected/Mono.DocTest/Widget.html,
566 Test/html.expected/Mono.DocTest/Widget+NestedClass+Double+Triple+Quadruple.html,
567 Test/html.expected/Mono.DocTest/Widget+NestedClass+Double+Triple.html,
568 Test/html.expected/Mono.DocTest/Widget+NestedClass+Double.html,
569 Test/msxdoc-expected.importslashdoc.xml: Flush.
571 2008-10-17 Jonathan Pryor <jpryor@novell.com>
573 * Makefile: Reference the monodoc.dll from the net_1_1 profile, as
574 that's the only one that will get built.
576 2008-10-17 Jonathan Pryor <jpryor@novell.com>
578 * Makefile: Fix $(EXTRA_DISTFILES) so that `make distcheck` doesn't
579 fail on mdoc anymore...
581 2008-10-18 Raja R Harinath <harinath@hurrynot.org>
583 * Makefile (MCS1): Use 'class/lib/net_1_1', not 'class/lib/1.0'.
585 2008-10-17 Jonathan Pryor <jpryor@novell.com>
587 * Mono.Documentation/monodocer.cs: -overrides & -pretty should default
588 to true. (Not a major change, as mdoc.exe already did this, so it
589 really only impacts monodocer1.exe, which is internal...)
591 2008-10-17 Jonathan Pryor <jpryor@novell.com>
593 * Mono.Documentation/monodocer.cs: Only provide a Main() method and
594 use Mono.GetOptions when targeting .NET 1.0 (i.e. monodocer1.exe).
596 2008-10-16 Jonathan Pryor <jpryor@novell.com>
598 Migration from monodoc/tools to mcs/tools/mdoc...
600 * . (svn:ignore), Test (svn:ignore): Ignore generated files.
601 * assembler.cs, mdoc.cs, monodocer.cs, monodocs2html.cs,
602 monodocs2slashdoc.cs, normalize.cs, validate.cs, XhtmlWriter.cs:
603 Move to Mono.Documentation.
604 * defaulttemplate.xsl, overview.xsl, stylesheet.xsl: Moved to
606 * DocTest: Moved to Test.
607 * DocTest-v1.cs, DocTest-v2.patch, TestEcmaDocs.xml: Moved to Test.
608 * mdoc.exe.sources: Added; mcs include file to build mdoc.exe.
609 * Makefile: Added; build mdoc.exe, monodocer1.exe, and unit tests for
611 * Mono.Documentation/assembler.cs, Mono.Documentation/normalize.cs,
612 Mono.Documentation/mdoc.cs, Mono.Documentation/monodocs2slashdoc.cs,
613 Mono.Documentation/monodocs2html.cs, Mono.Documentation/validate.cs:
614 Modify command line handling to remove Mono.GetOptions dependency.
615 * Test/DocTest-v1.cs: Update //code/@src attribute due to changed paths.
616 * Test/msxdoc-expected.importslashdoc.xml,
617 * Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml: Flush
618 due to above DocTest-v1.cs change.
620 2008-10-16 Jonathan Pryor <jpryor@novell.com>
622 * monodocer.cs: Fixup sorting of explicitly-implement generic members.
623 This keeps members from "bouncing around" in random orders when
624 updating documentation...
625 * DocTest-v1.cs: Explicitly implement some generic interface members on
626 MyList<A,B> to provoke the bug fixed above.
627 Dictionary<K,V>.ValueCollection in mscorlib was the original
629 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
630 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
631 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
632 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
633 DocTest/msxdoc-expected.importslashdoc.xml: Flush.
635 2008-10-15 Jonathan Pryor <jpryor@novell.com>
637 * monodocer.cs: Ignore some attributes, because they're ~meaningless
638 for documentation purposes (e.g. who cares if we need attributes to
639 represent decimal constants, or that a method shouldn't be stepped
640 into with the debugger, or...).
641 * DocTest/en.expected/index.xml,
642 * DocTest/en.expected/Mono.DocTest/Widget.xml,
643 * DocTest/en.expected/Mono.DocTest.Generic/Extensions.xml,
644 * DocTest/en.expected.since/index.xml,
645 * DocTest/en.expected.since/Mono.DocTest/Widget.xml,
646 * DocTest/en.expected.since/Mono.DocTest.Generic/Extensions.xml,
647 * DocTest/html.expected/Mono.DocTest/Widget.html,
648 * DocTest/html.expected/Mono.DocTest.Generic/Extensions.html,
649 * DocTest/en.expected.importslashdoc/index.xml,
650 * DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
651 * DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Extensions.xml:
654 2008-10-05 Jonathan Pryor <jpryor@novell.com>
656 * monodocer.cs: When sorting <Member/> elements elements, take generic
657 type parameters into account, so that methods with the same number
658 of type parameters are sorted together, instead of strewn across the
659 file according to the full //Member/@MemberName comparison.
660 * DocTest/**: Flush (and wtf is with the [DebuggerHidden] appearance?).
662 2008-09-19 Jonathan Pryor <jpryor@novell.com>
664 * DocTest-v1.cs: Add a member with a "deeply nested" generic parameter
665 list, so test the mdoc-html-utils.xsl fix.
666 * DocTest/msxdoc-expected.importslashdoc.xml,
667 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
668 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
669 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
670 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Flush.
672 2008-09-16 Jonathan Pryor <jpryor@novell.com>
674 * monodocer.cs: FieldInfo.GetValue() may throw, particularly if getting
675 the value of a public+static+readonly field, and the constructor for
676 the type of said field throws an exception (though DocTest-v1.cs has
677 a similar scenario). This is bad, as it prevents monodocer from
678 completing its work. Found by Dan Morgan.
679 * DocTest-v1.cs: Create a `public static readonly` field that will
680 generate an exception from the class constructor.
681 * DocTest/en.expected/Mono.DocTest/Widget.xml,
682 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
683 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
684 DocTest/html.expected/Mono.DocTest/Widget.html,
685 DocTest/msxdoc-expected.importslashdoc.xml: Flush.
687 2008-09-16 Jonathan Pryor <jpryor@novell.com>
689 * monodocer.cs: Allow #region/#endregion parsing to cope with blank lines.
691 2008-09-15 Jonathan Pryor <jpryor@novell.com>
693 * monodocer.cs: Strip off leading whitespace up to the indent level that
694 #region was found. This allows controlling how much leading whitespace is
695 preserved within the documentation (as too much whitespace will cause the
696 code to be indented significantly when rendered to e.g. html).
697 * DocTest-v1.cs: Indent the #region, to test the above.
698 * DocTest/msxdoc-expected.importslashdoc.xml,
699 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
700 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml:
703 2008-09-15 Jonathan Pryor <jpryor@novell.com>
705 * monodocer.cs: Allow //code/@src to include an anchor, in which the
706 anchor specifies a #region to include, instead of including the
707 entire document. This is currently limited to C# code. For example,
708 `<code lang="C#" src="foo.cs#Text"/>` would look insert all text
709 between `#region Text` and `#endregion` within foo.cs.
710 * DocTest-v1.cs: Add a #region, <code/> block to test the above.
711 * DocTest/msxdoc-expected.importslashdoc.xml,
712 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
713 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml:
716 2008-09-11 Jonathan Pryor <jpryor@novell.com>
718 * stylesheet.xsl: Post-process $cref so that we can use "nice"
719 //see/@cref strings that can actually refer to the right member.
720 For example, `<see cref="P:Foo.Bar{T}.Baz"/>` is needed to get a
721 nicely rendered "Foo.Bar<T>.Baz" link text, but previously it
722 wouldn't link to anything -- you'd need
723 `<see cref="P:Foo.Bar`1.Baz"/>` to get a functioning link for HTML
724 output. This now works.
726 2008-09-04 Jonathan Pryor <jpryor@novell.com>
728 * monodocer.cs: You can't use FieldInfo.GetValue() on generic types.
729 * DocTestv1.cs: Add checks for static fields on generic types.
732 2008-09-04 Jonathan Pryor <jpryor@novell.com>
734 * monodocer.cs: Clear out existing <value/> elements when import XML
735 documentation which also contains a <value/> element. (This keeps us from
736 getting multiple duplicate <value/> elements every time we update while
739 2008-08-31 Jonathan Pryor <jpryor@novell.com>
741 * DocTest-v1.cs: Update XML doc comment to mention correct cref.
742 * monodocer.cs: Further fixup XML documentation import and import the actual
743 *contents* of the <exception/> element (oops). Add support for importing
744 XML documentation for explicitly implemented interface members (CSC-style,
747 2008-08-27 Jonathan Pryor <jpryor@novell.com>
749 * monodocer.cs: Fixup XML documentation import to be more consistent with
750 ECMA XML import. In particular, this fixes <exception/> import so that
751 the same element isn't imported multiple times, leading to duplicate
752 <exception/> elements the more often monodocer is run.
753 * DocTest/msxdoc-expected.importslashdoc.xml,
754 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml: Flush.
755 Changes order of imported XML to reflect the original element order.
757 2008-08-11 Jonathan Pryor <jpryor@novell.com>
759 * monodocer.cs: Build fix (gmcs doesn't like using-alias-directives to
760 private nested types anymore).
762 2008-05-06 Wade Berrier <wberrier@novell.com>
764 * Makefile.am: Add Options.cs to EXTRA_DIST
766 2008-04-22 Jonathan Pryor <jpryor@novell.com>
768 * DocTest/en.expected/Mono.DocTest.Generic/Func`2.xml,
769 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Func`2.xml,
770 DocTest/en.expected.since/Mono.DocTest.Generic/Func`2.xml,
771 DocTest/html.expected/Mono.DocTest.Generic/Func`2.html: Flush: n377596
772 got fixed, so we can now retrieve custom attributes on all generic type
775 2008-04-15 Jonathan Pryor <jpryor@novell.com>
777 * . (svn:ignore): ignore generated files.
778 * Makefile.am: Add XmlDocUtils.cs to the build. Add unit tests for
779 monodocs2slashdoc; other monodocs2slashdoc changes.
780 * mdoc.cs: Update the arguments accepted by monodocs2slashdoc.
781 * monodocs2slashdoc.cs: Move DocUtils class into ../engine/XmlDocUtils.cs.
782 Add support for a -o parameter which contains all output (if specified).
784 - Add special support for extension methods -- index.xml now contains an
785 /Overview/ExtensionMethods element which contains ExtensionMethod
786 elements for all extension methods within all assemblies processed.
787 - The <ExtensionMethod/> element contains a subset of the <Member/> of the
788 actual extension method (and thus will contain a useful subset of the
789 documentation the source <Member/> contains), along with a <Targets/>
790 element describing all types the extension method applies to.
791 - Consequently, if you edit the documentation of your extension method,
792 you need to re-run monodocer to get the newly written documentation
793 inserted into index.xml.
794 - //Parameter/@RefType is "overloaded" to contain the "this" modifier of
795 extension methods (as this was easiest within mdoc-html-utils.xsl).
796 - Within CSharpMemberFormatter, insert generic type constraints for
797 methods. (Previously constraints were only done on types due to an
799 * monodocs2html.cs: Before rendering documentation via the XSLT, insert any
800 extension methods applicable to the type so that the extension methods
802 * DocTest-v1.cs: Add a class providing extension methods.
803 * stylesheet.xsl: Extension methods shouldn't be documented within the type,
804 just declared (and linked to the actual type's documentation).
805 * DocTest/msxdoc-expected.importslashdoc.xml: Added; expected output for
806 monodocs2slashdoc unit test.
807 * DocTest/en.expected/index.xml,
808 DocTest/en.expected/Mono.DocTest/UseLists.xml,
809 DocTest/en.expected/Mono.DocTest.Generic/Extensions.xml,
810 DocTest/en.expected/Mono.DocTest.Generic/Func`2.xml,
811 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
812 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
813 DocTest/en.expected.since/index.xml,
814 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
815 DocTest/en.expected.since/Mono.DocTest.Generic/Extensions.xml,
816 DocTest/en.expected.since/Mono.DocTest.Generic/Func`2.xml,
817 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
818 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
819 DocTest/en.expected.importslashdoc/index.xml,
820 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
821 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Extensions.xml,
822 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Func`2.xml,
823 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
824 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
825 DocTest/html.expected/index.html,
826 DocTest/html.expected/NoNamespace.html,
827 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
828 DocTest/html.expected/Mono.DocTest/DocValueType.html,
829 DocTest/html.expected/Mono.DocTest/IProcess.html,
830 DocTest/html.expected/Mono.DocTest/UseLists.html,
831 DocTest/html.expected/Mono.DocTest/Widget.html,
832 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
833 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
834 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
835 DocTest/html.expected/Mono.DocTest.Generic/index.html,
836 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
837 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.html,
838 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
839 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
840 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
841 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
842 DocTest/html.expected/System/Array.html: Flush; also contains additional
843 <Attributes/> elements on generic type parameters due to a mono fix.
845 2008-04-09 Jonathan Pryor <jpryor@novell.com>
847 * DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html: Fix the
848 System.EventHandler link.
850 2008-04-08 Jonathan Pryor <jpryor@novell.com>
852 * DocTest-v1.cs: Add more attributes, generic constraints to further test
854 * Makefile.am: Add check-md-html-dir target to help with testing
855 monodocs2html w/o re-generating the DocTest/en.actual directory.
856 * monodocer.cs: Lots of changes:
857 - Format change: /Type/TypeParameters/TypeParameter doesn't store the type
858 parameter name as it's value (e.g. <TypeParameter>A</TypeParameter>),
859 but instead stores the name as an attribute (e.g.
860 <TypeParameter Name="A" />). This was done as Generic Arguments can
861 contain both constraints and attributes which were previously
863 - Record constraints under a //TypeParameter/Constraints element, and
864 attributes under a //TypeParameter/Attributes element.
865 - Generic arguments for methods are now recorded in a
866 /Type/Members/Member/TypeParameters element, with the same schema as
867 type-level arguments.
868 - Properly insert the [return:...] attributes on delegates.
869 - Modify CSharpFullMemberFormatter to generate generic argument
870 constraints on type and member signatures.
871 - Note: attributes are currently not inserted due to n#322399.
872 * stylesheet.xsl: Properly escape generic type names so that all anchors
873 are modeled after ECMA-334 CREFs, e.g. T:Foo.Bar`1, not T:Foo.Bar<T>.
874 * DocTest/en.expected/index.xml,
875 DocTest/en.expected/Mono.DocTest/UseLists.xml,
876 DocTest/en.expected/Mono.DocTest/Widget.xml,
877 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
878 DocTest/en.expected/Mono.DocTest.Generic/Func`2.xml,
879 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
880 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
881 DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
882 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
883 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
884 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
885 DocTest/en.expected/System/Action`1.xml,
886 DocTest/en.expected/System/Array.xml,
887 DocTest/en.expected.since/index.xml,
888 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
889 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
890 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
891 DocTest/en.expected.since/Mono.DocTest.Generic/Func`2.xml,
892 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
893 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
894 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
895 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
896 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
897 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
898 DocTest/en.expected.since/System/Action`1.xml,
899 DocTest/en.expected.since/System/Array.xml,
900 DocTest/en.expected.importecmadoc/System/Action`1.xml,
901 DocTest/en.expected.importecmadoc/System/Array.xml,
902 DocTest/en.expected.importslashdoc/System/Array.xml,
903 DocTest/en.expected.importslashdoc/System/Action`1.xml,
904 DocTest/en.expected.importslashdoc/index.xml,
905 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
906 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
907 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
908 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
909 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
910 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Func`2.xml,
911 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
912 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
913 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
914 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
915 DocTest/html.expected/index.html,
916 DocTest/html.expected/Mono.DocTest/Widget.html,
917 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
918 DocTest/html.expected/Mono.DocTest/UseLists.html,
919 DocTest/html.expected/Mono.DocTest.Generic/index.html,
920 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
921 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.html,
922 DocTest/html.expected/Mono.DocTest.Generic/Func`2.html,
923 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
924 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
925 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
926 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
927 DocTest/html.expected/System/Action`1.html,
928 DocTest/html.expected/System/Array.html: Flush.
930 2008-04-04 Jonathan Pryor <jpryor@novell.com>
932 * DocTest-v1.cs: Add nested generic type for testing.
933 * DocTest/en.expected/index.xml,
934 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
935 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
936 DocTest/en.expected.importslashdoc/index.xml,
937 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
938 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
939 DocTest/en.expected.since/index.xml,
940 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
941 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
942 DocTest/html.expected/index.html,
943 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.html,
944 DocTest/html.expected/Mono.DocTest.Generic/index.html,
945 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html: Flush.
947 2008-03-31 Jonathan Pryor <jpryor@novell.com>
949 * DocTest-v1.cs: Add a member returning an IEnumerator<int[]> to test n375291.
950 * DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
951 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
952 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
953 DocTest/html.expected/Mono.DocTest/Widget.html,
954 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html: Flush.
956 2008-03-26 Jonathan Pryor <jpryor@novell.com>
958 * DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Flush due to
959 ../engine/mdoc-html-utils.xsl changes with migration of explicitly
960 implemented interface members to a separate section.
962 2008-03-26 Jonathan Pryor <jpryor@novell.com>
964 * DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
965 DocTest/html.expected/Mono.DocTest/UseLists.html: Flush due to
966 ../engine/mdoc-html-utils.xsl changes with s/System.Collections.Generic//.
969 2008-03-26 Jonathan Pryor <jpryor@novell.com>
971 * Makefile.am: Import docs for System.Action<T>.
972 * DocTest-v1.cs: Add System.Action<T> to test generic type importing.
973 * monodocer.cs: Misc. fixes:
974 - Properly lookup generic types when importing ECMA docs, so that e.g.
975 System.Collections.Generic.List<T> docs can be imported.
976 - Fix member duplicate checking so that we don't get an exception due to
977 seenmembers.Add(sig, "") for duplicate sigs.
978 - Fix UpdateParameters() to handle updating <param/> nodes on delegates.
979 * TestEcmaDocs.xml: Add docs for System.Action<T>.
980 * DocTest/en.expected/index.xml, DocTest/en.expected/System/Action`1.xml,
981 DocTest/en.expected.importecmadoc/System/Action`1.xml,
982 DocTest/en.expected.importslashdoc/index.xml,
983 DocTest/en.expected.importslashdoc/System/Action`1.xml,
984 DocTest/en.expected.since/index.xml,
985 DocTest/en.expected.since/System/Action`1.xml,
986 DocTest/html.expected/index.html, DocTest/html.expected/System/index.html,
987 DocTest/html.expected/System/Action`1.html: Flush.
989 2008-03-25 Jonathan Pryor <jpryor@novell.com>
991 * stylesheet.xsl: Implement CreateEditLink() for mdoc-html-utils.xsl.
993 2008-03-24 Jonathan Pryor <jpryor@novell.com>
995 * stylesheet.xsl: Implement CreateExpandedToggle() for
996 mdoc-sections-css.xsl.
998 2008-03-24 Jonathan Pryor <jpryor@novell.com>
1000 * DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Flush due to
1001 changes in ID string generation in ../engine/mdoc-html-utils.xsl.
1003 2008-03-17 Jonathan Pryor <jpryor@novell.com>
1005 * monodocer.cs: Modify index.xml so that there's a //Type/@Kind attribute.
1006 This allows mkestner's doc engine to display the tree view (e.g. "Foo
1007 Class") w/o loading the underlying Foo.xml file, improving start time.
1008 * DocTest/en.expected/index.xml, DocTest/en.expected.since/index.xml,
1009 DocTest/en.expected.importslashdoc/index.xml: Flush.
1011 2008-03-15 Jonathan Pryor <jpryor@novell.com>
1013 * monodocs2html.cs: Fix DumpTemplate() -- sending the output through an
1014 intermediate XmlDocument seems to "corrupt" the file, such that any user
1015 of the dumped file will get errors such as "Could not resolve named
1016 template create-default-style."
1018 2008-03-15 Jonathan Pryor <jpryor@novell.com>
1020 * defaulttemplate.xsl: Cleanup (add/remove CSS properties, etc.).
1021 * Makefile.am: monodocs2html needs to pull in resources from ../engine.
1022 * monodocs2html.cs: Use ManifestResourceResolver so that .xsl files embedded
1023 within the monodocs2html.exe assembly can refer to each other; use
1024 XhtmlWriter so that certain XHTML elements are "closed", e.g. <br/>
1025 instead of <br></br>.
1026 * XhtmlWriter.cs: Added; XmlWriter subclass which generates nicer XHTML.
1027 * stylesheet.xsl: *Major* refactor to share XSLT code with ../engine.
1028 * DocTest/html.expected/index.html, DocTest/html.expected/NoNamespace.html,
1029 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
1030 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1031 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1032 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1033 DocTest/html.expected/Mono.DocTest.Generic/index.html,
1034 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1035 DocTest/html.expected/Mono.DocTest/Color.html,
1036 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
1037 DocTest/html.expected/Mono.DocTest/Widget.html,
1038 DocTest/html.expected/Mono.DocTest/Widget+Del.html,
1039 DocTest/html.expected/Mono.DocTest/DocValueType.html,
1040 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
1041 DocTest/html.expected/Mono.DocTest/IProcess.html,
1042 DocTest/html.expected/Mono.DocTest/index.html,
1043 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
1044 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
1045 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
1046 DocTest/html.expected/Mono.DocTest/UseLists.html,
1047 DocTest/html.expected/System/Environment+SpecialFolder.html,
1048 DocTest/html.expected/System/Array.html,
1049 DocTest/html.expected/System/Environment.html,
1050 DocTest/html.expected/System/index.html,
1051 DocTest/html.expected/System/AsyncCallback.html: Flush.
1053 2008-03-07 Jonathan Pryor <jpryor@novell.com>
1055 * mdoc.cs: Rename export-slashdoc command to export-msxdoc. Add a space
1056 between the `usage:' and command description to ease reading.
1058 2008-03-07 Jonathan Pryor <jpryor@novell.com>
1060 * monodocs2slashdoc.cs: Update to cope with .NET 2.0 generics.
1061 * DocTest-v1.cs: Fix CREF comments.
1062 * DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1063 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1064 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
1065 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html: Flush
1066 due to above CREF changes.
1068 2008-03-06 Joshua Tauberer <jit@occams.info>
1070 * monodocer.cs: Use Path.Combine in a few places.
1072 2008-03-03 Jonathan Pryor <jpryor@novell.com>
1074 * Makefile.am: Test the new -import: monodocer option.
1075 * mdoc.cs: Make --import take only one parameter, the file to import.
1076 * monodocer.cs: Add a new -import option which auto-detects the XML format
1077 so that mdoc (and the user) doesn't need to care about file formats.
1078 * Options.cs: Flush (fixes "<>" error when parsing 2-value "i|import").
1080 2008-02-29 Jonathan Pryor <jpryor@novell.com>
1082 * Makefile.am: Use mcs1 to build monodocer1.exe (as mcs now targets the 2.0
1083 profile by default).
1085 2008-02-29 Jonathan Pryor <jpryor@novell.com>
1087 * Makefile.am: Corrections to pass distcheck.
1089 2008-02-27 Jonathan Pryor <jpryor@novell.com>
1091 * mdoc.cs: `mdoc assemble` should default to the "ecma" format, as that's
1092 what most of the other mdoc tools produce & consume.
1094 2008-02-26 Jonathan Pryor <jpryor@novell.com>
1096 * mdoc.cs: Allow multiple formats to be specified on the `mdoc assemble`
1097 command line; directories use the last specified format. This allows more
1098 than one format to be specified at once, e.g.
1099 `mdoc assemble -o foo --format=ecma A B --format=error C D`.
1100 * Options.cs: Update to permit the above "argument run" parsing behavior.
1102 2008-02-24 Jonathan Pryor <jpryor@novell.com>
1104 * mdoc.cs: Remove array index out of bound exception in ExportHtml; remove
1106 * defaulttemplate.xsl: s/<tab>/ /; add create-default-collection-title,
1107 create-default-title, create-default-summary, create-default-signature,
1108 create-default-remarks, create-default-members named templates (for use by
1109 importing XSLT files).
1110 * DocTest/html.expected/**/*.html: Flush (whitespace changes).
1112 2008-02-21 Jonathan Pryor <jpryor@novell.com>
1114 * Makefile.am: Add mdoc.exe to the build.
1115 * monodocer.cs: Place into the Mono.Documentation namespace;
1116 rename Stub to Updater.
1117 * monodocs2slashdoc.cs: Place into the Mono.Documentation namespace; allow
1118 it to convert multiple directories.
1119 * mdoc.cs: Added; a unifying front-end to the various monodoc-related
1120 utilities such as monodocer, monodocs2html, mdassembler, etc.
1121 * Options.cs: An option parser; DO NOT EDIT; instead, see NDesk.Options at
1122 http://www.ndesk.org/Options.
1124 2008-02-19 Jonathan Pryor <jpryor@novell.com>
1126 * defaulttemplate.xsl: Insert id attributes so that an "index" can be added;
1127 Add a small "index" to the top of the page to simplify navigation --
1128 useful when there are lots of docs that make the "Members" section
1129 difficult to otherwise find. Add a http-equiv Content-Type, so that the
1130 charset is set to UTF-8.
1131 * stylesheet.xsl: Don't use generate-id(), as the result includes the full
1132 path of the input file, which breaks unit tests if run on a different
1133 machine (and everyone runs the unit tests, right?). Add id attributes so
1134 that defaulttemplate.xsl can create an index.
1135 * DocTest/html.expected/System/Environment+SpecialFolder.html,
1136 DocTest/html.expected/System/Array.html,
1137 DocTest/html.expected/System/Environment.html,
1138 DocTest/html.expected/System/index.html,
1139 DocTest/html.expected/System/AsyncCallback.html,
1140 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
1141 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1142 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1143 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1144 DocTest/html.expected/Mono.DocTest.Generic/index.html,
1145 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1146 DocTest/html.expected/index.html,
1147 DocTest/html.expected/Mono.DocTest/Color.html,
1148 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
1149 DocTest/html.expected/Mono.DocTest/Widget.html,
1150 DocTest/html.expected/Mono.DocTest/Widget+Del.html,
1151 DocTest/html.expected/Mono.DocTest/DocValueType.html,
1152 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
1153 DocTest/html.expected/Mono.DocTest/IProcess.html,
1154 DocTest/html.expected/Mono.DocTest/index.html,
1155 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
1156 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
1157 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
1158 DocTest/html.expected/Mono.DocTest/UseLists.html,
1159 DocTest/html.expected/NoNamespace.html: Flush.
1161 2008-02-15 Jonathan Pryor <jpryor@novell.com>
1163 * defaulttemplate.xsl: Move the <style/> and (new) <script/> into named
1164 templates so that this file can be <xsl:import/>d and the named templates
1165 invoked without clobbering the importing document; add toggle_display()
1166 JavaScript function for some bling. Modify CSS so things look nicer.
1167 * stylesheet.xsl: Make monodocs2html output not suck (as badly):
1168 - Allow *all* headers to also act as show/hide toggles, so that e.g.
1169 Remarks, Examples, Parameters, etc. can be hidden.
1170 - Move the summary information above the member prototype (consistent
1171 with MSDN, and I think it looks nicer).
1172 - Provide an `id' attribute for enumeration members, so that
1173 <see cref="F:..." /> will work reasonably.
1174 - Allow the <pre/> blocks to use the `prettyprint.js' file (used by
1175 monologue for syntax coloring) -- requires setting the <pre/> class to
1176 e.g. code-csharp for C# coloring.
1177 * DocTest/html.expected/System/Environment+SpecialFolder.html,
1178 DocTest/html.expected/System/Array.html,
1179 DocTest/html.expected/System/Environment.html,
1180 DocTest/html.expected/System/index.html,
1181 DocTest/html.expected/System/AsyncCallback.html,
1182 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
1183 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1184 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1185 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1186 DocTest/html.expected/Mono.DocTest.Generic/index.html,
1187 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1188 DocTest/html.expected/index.html,
1189 DocTest/html.expected/Mono.DocTest/Color.html,
1190 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
1191 DocTest/html.expected/Mono.DocTest/Widget.html,
1192 DocTest/html.expected/Mono.DocTest/Widget+Del.html,
1193 DocTest/html.expected/Mono.DocTest/DocValueType.html,
1194 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
1195 DocTest/html.expected/Mono.DocTest/IProcess.html,
1196 DocTest/html.expected/Mono.DocTest/index.html,
1197 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
1198 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
1199 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
1200 DocTest/html.expected/Mono.DocTest/UseLists.html,
1201 DocTest/html.expected/NoNamespace.html: Flush (lots of HTML changes due to
1202 defaulttemplate.xsl and stylesheet.xsl changes).
1204 2008-02-14 Jonathan Pryor <jpryor@novell.com>
1206 * stylesheet.xsl: Support <typeparamref/>.
1208 2008-02-13 Jonathan Pryor <jpryor@novell.com>
1210 * DocTest-v1.cs: Add/fix doc comments; add a
1211 Widget(Converter<string,string>) constructor for testing.
1212 * stylesheet.xsl: Fix display issues:
1213 - Generic types should have GetTypeDisplayName() on their constituent
1214 parts, so System.Converter<System.String,System.String>
1215 gets converted into the nicer Converter<string, string>.
1216 - Generic types within method argument lists should be supported.
1217 - Permit constructor references to contain arguments, so that
1218 "C:My.Full.Type(Type1,Type2)" actually works.
1219 - Fix remote type references so
1220 <see cref="M:System.Collections.Generic.List{System.Int32}.Remove(`0)"/>
1221 properly reference the remote uri
1222 System.Collections.Generic.List`1.Remove(`0).
1223 * DocTest/en.expected/Mono.DocTest/Widget.xml,
1224 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
1225 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1226 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1227 DocTest/html.expected/System/Array.html,
1228 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1229 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1230 DocTest/html.expected/Mono.DocTest/Widget.html,
1231 DocTest/html.expected/Mono.DocTest/UseLists.html: Flush.
1233 2008-02-08 Jonathan Pryor <jpryor@novell.com>
1235 * stylesheet.xsl: Allow use of both <see cref="GenericType{A}" /> and
1236 <see cref="GenericType<A>" /> to be consistent wrt each other.
1237 - Canonicalize generic types within link targets so that {} is used, as
1238 1. this is what the */@id code generates, so such links will actually
1239 work (as opposed to <>-using links, which will fail), and
1240 2. the {} links are shorter and easier to read due to less markup.
1241 - Canonicalize generic types within link text to use <>, so e.g.
1242 <see cref="System.Action{`0}" /> is displayed as System.Action<`0>.
1243 This also allows output to be consistent, no matter what the see/@cref
1245 - When creating links to go-mono.com, ensure that generic type names are
1246 of the form Type`N, not Type{...}, as go-mono.com doesn't generate
1247 useful output for the latter form of URL.
1248 * DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Flush.
1250 2008-01-06 Jonathan Pryor <jpryor@novell.com>
1252 * monodocer.cs: Yet another "if you remove a node while traversing its
1253 containing list, you skip elements" bug (in this case, if you had extra
1254 <param/> elements for non-existant parameters, only the first extra
1255 <param/> was removed, and the others were skipped). Modify the messge
1256 displayed for undeletable <param/> nodes to provide more contextual
1259 2008-01-05 Jonathan Pryor <jpryor@novell.com>
1262 - Fix duplicate and removed member checking/handling, so that duplicate
1263 and removed members are properly warned about/removed (depending
1264 on MemberDocsHaveUserContent()).
1265 - Member sorting should take the return type into consideration, as I've
1266 seen some ../class/** members which change the return type between
1267 v1.0 and v2.0, causing the order of these members to "float" (as they
1268 previously had the same sort order).
1270 2008-01-03 Jonathan Pryor <jpryor@novell.com>
1272 * monodocer.cs: XmlNodeList doesn't appear to support removing nodes while
1273 you're traversing the list. (It doesn't complain, but it doesn't iterate
1274 over all the nodes either if you do so.) Don't do that.
1276 2008-01-02 Jonathan Pryor <jpryor@novell.com>
1278 * monodocer.cs: Don't generate files that contain characters that are
1279 invalid on Win32 platforms. These are frequently compiler-generated
1280 types, e.g. '<>c__CompilerGenerated2+<>c__CompilerGenerated13', but are
1281 occasionally public when they shouldn't be. Fix the
1282 UpdateAssemblyVersions() logic to return true IFF there are > 0
1283 <AssemblyVersion/> elements.
1285 2008-01-02 Jonathan Pryor <jpryor@novell.com>
1287 * DocTest-v1.cs: Add a type to the root namespace.
1288 * monodocer.cs: Permit types to exist in the root namespace. This is needed
1289 to properly document ../class/Npgsql, though I have no idea how `monodoc'
1290 will actually display these types...
1291 * overview.xsl: Support types within the root namespace.
1292 * DocTest/en.expected/index.xml, DocTest/en.expected.since/index.xml,
1293 DocTest/en.expected.importslashdoc/index.xml,
1294 DocTest/html.expected/System/index.html,
1295 DocTest/html.expected/Mono.DocTest.Generic/index.html,
1296 DocTest/html.expected/index.html,
1297 DocTest/html.expected/Mono.DocTest/index.html: Flush.
1298 * DocTest/en.expected/NoNamespace.xml,
1299 DocTest/en.expected/ns-.xml,
1300 DocTest/en.expected.importslashdoc/NoNamespace.xml,
1301 DocTest/en.expected.importslashdoc/ns-.xml,
1302 DocTest/en.expected.since/NoNamespace.xml,
1303 DocTest/en.expected.since/ns-.xml,
1304 DocTest/html.expected/NoNamespace.html: Added.
1306 2008-01-02 Jonathan Pryor <jpryor@novell.com>
1309 - Write namespace files as 'ns-<Namespace>.xml', not '<Namespace>.xml', as
1310 the previous behavior would break monodoc checkout on Win32 (due to dir
1311 class/System.Security/en/System.Security.Cryptography.Xml vs. file
1312 class/System.Security/en/System.Security.Cryptography.xml).
1313 - This will rename existing <Namespace>.xml to ns-<Namespace>.xml
1315 - gmcs/mcs changed Reflection names (again); cope.
1316 * DocTest/en.expected/System.xml,
1317 DocTest/en.expected/Mono.DocTest.Generic.xml,
1318 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1319 DocTest/en.expected/Mono.DocTest.xml, DocTest/en.expected.since/System.xml,
1320 DocTest/en.expected.since/Mono.DocTest.Generic.xml,
1321 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1322 DocTest/en.expected.since/Mono.DocTest.xml,
1323 DocTest/en.expected.importslashdoc/System.xml,
1324 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic.xml,
1325 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1326 DocTest/en.expected.importslashdoc/Mono.DocTest.xml: Rename to have a
1328 * Makefile.am: Remove obsolete targets; add -show_exceptions to tests so we
1329 get more information on errors.
1330 * overview.xsl: Use the 'ns-' prefixed namespace documentation files.
1332 2007-12-19 Jonathan Pryor <jpryor@novell.com>
1334 * monodocer.cs: PropertyInfo.GetValue() may throw (in particular, within
1335 System.Data when trying to read ToolboxItemAttribute which references an
1336 assembly not present within the GAC). Workaround this.
1338 2007-12-19 Jonathan Pryor <jpryor@novell.com>
1340 * monodocer.cs: Add a -show_exceptions argument to provide full stack traces
1341 when an error occurs (helps with debugging). Allow VersionComparer to
1342 work on "slightly" malformed Version strings like 1.0.x.x, which some
1343 existing documentation uses.
1345 2007-12-18 Jonathan Pryor <jpryor@novell.com>
1347 * monodocer.cs: Don't append ';' to property declarations.
1348 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1349 DocTest/en.expected/Mono.DocTest/Widget.xml,
1350 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1351 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1352 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1353 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml: Flush.
1355 2007-12-18 Jonathan Pryor <jpryor@novell.com>
1357 * monodocer.cs: Insert [return:] custom attributes within <ReturnValue/>.
1358 * DocTest-v1.cs: Add custom attributes to various members for testing.
1359 * DocTest/en.expected/Mono.DocTest/Widget.xml,
1360 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
1361 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1362 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
1363 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
1364 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
1365 DocTest/html.expected/Mono.DocTest/Widget.html,
1366 DocTest/html.expected/Mono.DocTest/DocAttribute.html: Flush.
1368 2007-12-17 Jonathan Pryor <jpryor@novell.com>
1370 * monodocer.cs: Document protected events.
1371 * DocTest-v1.cs: Change the visibility of various members so we can better
1372 test the monodocs2html output.
1373 * stylesheet.xsl: Fix the `protected' check so that public members aren't
1374 displayed under the Protected [MemberType] section.
1375 * DocTest/en.expected/Mono.DocTest/Widget.xml,
1376 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1377 DocTest/html.expected/Mono.DocTest/Widget.html,
1378 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml: Flush.
1380 2007-12-13 Jonathan Pryor <jonpryor@vt.edu>
1382 * monodocer.cs: Er, *really* sort the <AssemblyVersion/> entries.
1384 2007-12-12 Jonathan Pryor <jonpryor@vt.edu>
1386 * monodocer.cs: Sort the <AssemblyVersion/> entries so that when rendering
1387 them within monodoc we show versions in increasing order.
1389 2007-12-11 Jonathan Pryor <jonpryor@vt.edu>
1391 * monodocer.cs: Don't use File.OpenWrite(), as that doesn't truncate the
1392 file (resulting in invalid XML errors if the new file is smaller than the
1393 previous file). Add a local OpenWrite() to ensure that UTF8 is used
1396 2007-12-11 Jonathan Pryor <jonpryor@vt.edu>
1398 * monodocer.cs: Generate a per-member <AssemblyInfo/> element, not an
1399 <AssemblyVersions/> element. This makes it easeier to write the XSLT
1400 used in the docbrowser to generate the Requirements section.
1401 * stylesheet.xsl: Use <AssemblyInfo/>, not <AssemblyVersions/>.
1402 * DocTest/en.expected/System/Environment.xml,
1403 DocTest/en.expected/System/AsyncCallback.xml,
1404 DocTest/en.expected/System/Environment+SpecialFolder.xml,
1405 DocTest/en.expected/System/Array.xml,
1406 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
1407 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1408 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
1409 DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
1410 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1411 DocTest/en.expected/Mono.DocTest/Widget.xml,
1412 DocTest/en.expected/Mono.DocTest/Widget+Del.xml,
1413 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
1414 DocTest/en.expected/Mono.DocTest/IProcess.xml,
1415 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
1416 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
1417 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
1418 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1419 DocTest/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
1420 DocTest/en.expected/Mono.DocTest/Color.xml,
1421 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
1422 DocTest/en.expected.since/System/Environment.xml,
1423 DocTest/en.expected.since/System/AsyncCallback.xml,
1424 DocTest/en.expected.since/System/Environment+SpecialFolder.xml,
1425 DocTest/en.expected.since/System/Array.xml,
1426 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
1427 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1428 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1429 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
1430 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1431 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1432 DocTest/en.expected.since/Mono.DocTest/AddedType.xml,
1433 DocTest/en.expected.since/Mono.DocTest/Widget+Del.xml,
1434 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
1435 DocTest/en.expected.since/Mono.DocTest/IProcess.xml,
1436 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
1437 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
1438 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
1439 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1440 DocTest/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
1441 DocTest/en.expected.since/Mono.DocTest/Color.xml,
1442 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
1443 DocTest/en.expected.importecmadoc/System/Environment.xml,
1444 DocTest/en.expected.importecmadoc/System/AsyncCallback.xml,
1445 DocTest/en.expected.importecmadoc/System/Array.xml,
1446 DocTest/en.expected.importslashdoc/System/Environment.xml,
1447 DocTest/en.expected.importslashdoc/System/AsyncCallback.xml,
1448 DocTest/en.expected.importslashdoc/System/Environment+SpecialFolder.xml,
1449 DocTest/en.expected.importslashdoc/System/Array.xml,
1450 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
1451 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1452 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1453 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1454 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1455 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
1456 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
1457 DocTest/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
1458 DocTest/en.expected.importslashdoc/Mono.DocTest/IProcess.xml,
1459 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass.xml,
1460 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
1461 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
1462 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1463 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
1464 DocTest/en.expected.importslashdoc/Mono.DocTest/Color.xml,
1465 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml:
1466 Flush; s/AssemblyVersion/AssemblyInfo/g.
1468 2007-12-10 Jonathan Pryor <jonpryor@vt.edu>
1470 * DocTest-v2.patch: Remove some members so that we can see some
1471 <AssemblyVersions/> differences in the XML output.
1472 * monodocer.cs: Add a <AssemblyVersions/> element under every type and member
1473 to better track versioning information. The XML documentation now becomes
1474 a "version database" of sorts, in which each member lists which assembly
1475 versions it exists in. This permits tracking which members were added or
1476 removed over time with greater fidelity than <since/>. This also removes
1477 the need for -ignore_extra_docs, which is maintained (for compatibility)
1479 * DocTest-v1.cs: Have differing visibility on a property to ensure it works
1481 * stylesheet.xsl: Print out the per-member <AssemblyVersions/> element.
1482 * DocTest/en.expected/System/Environment.xml,
1483 DocTest/en.expected/System/AsyncCallback.xml,
1484 DocTest/en.expected/System/Environment+SpecialFolder.xml,
1485 DocTest/en.expected/System/Array.xml,
1486 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
1487 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1488 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
1489 DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
1490 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1491 DocTest/en.expected/Mono.DocTest/Widget.xml,
1492 DocTest/en.expected/Mono.DocTest/Widget+Del.xml,
1493 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
1494 DocTest/en.expected/Mono.DocTest/IProcess.xml,
1495 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
1496 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
1497 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
1498 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1499 DocTest/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
1500 DocTest/en.expected/Mono.DocTest/Color.xml,
1501 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
1502 DocTest/en.expected.since/System/Environment.xml,
1503 DocTest/en.expected.since/System/AsyncCallback.xml,
1504 DocTest/en.expected.since/System/Environment+SpecialFolder.xml,
1505 DocTest/en.expected.since/System/Array.xml,
1506 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
1507 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1508 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1509 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
1510 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1511 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1512 DocTest/en.expected.since/Mono.DocTest/AddedType.xml,
1513 DocTest/en.expected.since/Mono.DocTest/Widget+Del.xml,
1514 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
1515 DocTest/en.expected.since/Mono.DocTest/IProcess.xml,
1516 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
1517 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
1518 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
1519 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1520 DocTest/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
1521 DocTest/en.expected.since/Mono.DocTest/Color.xml,
1522 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
1523 DocTest/html.expected/System/Array.html,
1524 DocTest/html.expected/System/Environment.html,
1525 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
1526 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1527 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1528 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1529 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1530 DocTest/html.expected/Mono.DocTest/Widget.html,
1531 DocTest/html.expected/Mono.DocTest/DocValueType.html,
1532 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
1533 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
1534 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
1535 DocTest/html.expected/Mono.DocTest/UseLists.html,
1536 DocTest/en.expected.importecmadoc/System/Environment.xml,
1537 DocTest/en.expected.importecmadoc/System/AsyncCallback.xml,
1538 DocTest/en.expected.importecmadoc/System/Array.xml,
1539 DocTest/en.expected.importslashdoc/System/Environment.xml,
1540 DocTest/en.expected.importslashdoc/System/AsyncCallback.xml,
1541 DocTest/en.expected.importslashdoc/System/Environment+SpecialFolder.xml,
1542 DocTest/en.expected.importslashdoc/System/Array.xml,
1543 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
1544 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1545 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1546 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1547 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1548 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
1549 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
1550 DocTest/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
1551 DocTest/en.expected.importslashdoc/Mono.DocTest/IProcess.xml,
1552 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass.xml,
1553 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
1554 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
1555 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1556 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
1557 DocTest/en.expected.importslashdoc/Mono.DocTest/Color.xml,
1558 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml:
1559 Flush, inserting <AssemblyVersion/> elements as necessary.
1561 2007-10-28 Jonathan Pryor <jonpryor@vt.edu>
1563 * DocTest-v1.cs: Correct doc comment.
1564 * DocTest/html.expected/System/Environment.html,
1565 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
1566 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1567 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1568 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1569 DocTest/html.expected/Mono.DocTest/UseLists.html,
1570 DocTest/en.expected.importslashdoc/System/Environment.xml,
1571 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
1572 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1573 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1574 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1575 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml: mcs and gmcs
1576 got many bug fixes with /doc support, changing many things that depend on
1579 2007-09-27 Raja R Harinath <rharinath@novell.com>
1581 * Makefile.am (DocTest.dll-v1, DocTest.dll-v2): Pick source from $srcdir.
1583 2007-07-19 Jonathan Pryor <jonpryor@vt.edu>
1585 * monodocer.cs: Always fully consume <Docs/> children. If we have e.g.
1586 <Docs><param name="foo"><see cref="T:Bar"/></param></Docs>, but there is
1587 no existing parameter "foo", we would previously process the nested
1588 <see/> node and append it to the <Docs/> child nodes.
1590 2007-07-18 Jonathan Pryor <jonpryor@vt.edu>
1592 * monodocer.cs: Change OrderDocsNodes() so that it uses
1593 XmlNode.InsertAfter() instead of XmlNode.InsertBefore(). The result is
1594 mostly the same (i.e. no regression test changes), but if you have a
1595 non-ordered node between other nodes this will force the non-ordered node
1596 to the *end* of the <Docs/> children, not the start. For example, given
1597 the input <Docs><summary/><exception/><remarks/></Docs/>, we used to get
1598 <Docs><exception/><summary/><remarks/></Docs>, while we now get
1599 <Docs><summary/><remarks/><exception/></Docs>.
1601 2007-07-17 Jonathan Pryor <jonpryor@vt.edu>
1603 * monodocer.cs: Insert the type's <Docs/> node before <Members/>. This is
1604 consistent with ECMA documentation ordering, and makes more sense (when
1605 editing the file you can edit the Type documentation before member
1606 documentation, instead of after all members as was the case before).
1607 * DocTest/en.expected/System/Environment.xml,
1608 DocTest/en.expected/System/Environment+SpecialFolder.xml,
1609 DocTest/en.expected/System/Array.xml,
1610 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
1611 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1612 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
1613 DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
1614 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1615 DocTest/en.expected/Mono.DocTest/Widget.xml,
1616 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
1617 DocTest/en.expected/Mono.DocTest/IProcess.xml,
1618 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
1619 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
1620 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
1621 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1622 DocTest/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
1623 DocTest/en.expected/Mono.DocTest/Color.xml,
1624 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
1625 DocTest/en.expected.since/System/Environment.xml,
1626 DocTest/en.expected.since/System/Environment+SpecialFolder.xml,
1627 DocTest/en.expected.since/System/Array.xml,
1628 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
1629 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1630 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1631 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
1632 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1633 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1634 DocTest/en.expected.since/Mono.DocTest/AddedType.xml,
1635 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
1636 DocTest/en.expected.since/Mono.DocTest/IProcess.xml,
1637 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
1638 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
1639 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
1640 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1641 DocTest/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
1642 DocTest/en.expected.since/Mono.DocTest/Color.xml,
1643 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
1644 DocTest/en.expected.importecmadoc/System/Environment.xml,
1645 DocTest/en.expected.importecmadoc/System/Array.xml,
1646 DocTest/en.expected.importslashdoc/System/Environment.xml,
1647 DocTest/en.expected.importslashdoc/System/Environment+SpecialFolder.xml,
1648 DocTest/en.expected.importslashdoc/System/Array.xml,
1649 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
1650 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1651 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1652 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1653 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1654 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
1655 DocTest/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
1656 DocTest/en.expected.importslashdoc/Mono.DocTest/IProcess.xml,
1657 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass.xml,
1658 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
1659 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
1660 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1661 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
1662 DocTest/en.expected.importslashdoc/Mono.DocTest/Color.xml,
1663 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml:
1664 Update so that <Docs/> comes before <Members/>, not after.
1666 2007-07-14 Jonathan Pryor <jonpryor@vt.edu>
1668 * monodocer.cs: If a <Type/> had an empty <Members/> element, we'd start
1669 reading the <Member/> elements from the *next* <Type/>; oops.
1670 * DocTest-v1.cs: Add System.AsyncCallback, which is a delegate and thus had
1671 an empty <Members/> element.
1672 * Makefile.am: Also import docs for System.AsyncCallback.
1673 * overview.xsl: Update $max-types so that adding System.AsyncCallback
1674 doesn't trigger the alternate behavior, creating a larger diff than
1676 * TestEcmaDocs.xml: Add docs for System.AsyncCallback.
1677 * DocTest/en.expected/System/AsyncCallback.xml,
1678 DocTest/en.expected/index.xml,
1679 DocTest/en.expected.since/System/AsyncCallback.xml
1680 DocTest/en.expected.since/index.xml,
1681 DocTest/html.expected/System/AsyncCallback.html
1682 DocTest/html.expected/System/index.html, DocTest/html.expected/index.html,
1683 DocTest/en.expected.importecmadoc/System/AsyncCallback.xml,
1684 DocTest/en.expected.importslashdoc/System/AsyncCallback.xml,
1685 DocTest/en.expected.importslashdoc/index.xml: Added; expected imported
1686 documentation for System.AsyncCallback.
1688 2007-07-14 Jonathan Pryor <jonpryor@vt.edu>
1690 * monodocer.cs: Remove the "While Importing ECMA <Docs/> chidren, found
1691 node..." error by ensuring that we're at the start of an actual
1692 non-whitespace element before hitting the switch statement.
1694 2007-07-14 Jonathan Pryor <jonpryor@vt.edu>
1696 * monodocer.cs: Don't call DoUpdateType() with non-public types. This
1697 allows `monodocer -importecmadoc` to fully run and import mscorlib.dll.
1699 2007-07-14 Jonathan Pryor <jonpryor@vt.edu>
1701 * monodocer.cs: Ensure that getting a MemberInfo based on the documentation
1702 that the MemberInfo was actually found... (Allows a full mscorlib.dll
1703 import to run for > 15s before dying.)
1705 2007-07-04 Jonathan Pryor <jonpryor@vt.edu>
1707 * monodocer.cs: Use XmlReader instead of XPathDocument to process the ECMA
1708 documentation import. This cuts down a -type:System.Array import from
1709 ~10-12s to ~7-8s (not great, but better). "Fix" the ordering of <Docs/>
1710 child elements so that importing ECMA/slashdoc documentation doesn't
1711 change the normal ordering.
1712 * DocTest/en.expected.importecmadoc/System/Array.xml,
1713 DocTest/en.expected.importecmadoc/System/Environment.xml: Alter order of
1714 <Docs/> elements to match the normally generated order.
1716 2007-06-20 Jonathan Pryor <jonpryor@vt.edu>
1718 * monodocer.cs: Sort /Type/Members/Member elements so that the order is not
1719 dependent upon Reflection order.
1720 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1721 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1722 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1723 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1724 DocTest/en.expected.importecmadoc/System/Array.xml,
1725 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml:
1726 Flush (sort <Member/> elements).
1728 2007-06-19 Jonathan Pryor <jonpryor@vt.edu>
1730 * monodocer.cs: Sort <Namespace/> and <Type/> elements by their Name
1731 attribute. This helps keep diff's smaller, as the generated order won't
1732 be dependent upon Reflection order.
1733 * DocTest/en.expected/index.xml, DocTest/en.expected.since/index.xml,
1734 DocTest/en.expected.importslashdoc/index.xml: Flush (sort namespaces and
1735 types alphabetically).
1737 2007-06-19 Jonathan Pryor <jonpryor@vt.edu>
1739 * monodocer.cs: Cleanup Console output.
1740 - Use Console.Error for error messages, not status messages.
1741 - Error should be prefixed by "monodocer" (follows Unix conventions).
1742 - Don't print "Updating..." followed by "New Type..." for the same type.
1743 - Use __monodocer-seen__ sentinal for imported nodes so that we don't try
1744 to lookup the corresponding member later in GetDocumentationMembers().
1746 2007-06-19 Jonathan Pryor <jonpryor@vt.edu>
1748 * monodocer.cs: Lots 'o fixes/improvements.
1749 - Allow multiple -type parameters to be specified.
1750 - Remove type member enumeration from UpdateTypes() -- use DoUpdateType2().
1751 - Iterate over assembly types in Ecma Documentation order (so that we read
1752 the Ecma docs sequentially, not randomly).
1753 - Allow -type to *create* new documentation files.
1754 - Remove unused methods.
1755 * Makefile.am: Add check-monodocer-importecmadoc,
1756 check-monodocer-importecmadoc-update targets (unit tests for
1758 * TestEcmaDocs.xml: Added; ECMA Documentation input file for use with
1759 -importecmadoc tests.
1760 * DocTest-v1.cs: Add System.Array to help test -importecmadoc behavior.
1761 * DocTest/en.expected/index.xml, DocTest/en.expected.since/index.xml,
1762 DocTest/html.expected/System/index.html, DocTest/html.expected/index.html,
1763 DocTest/en.expected.importslashdoc/index.xml: Flush (add System.Array to
1765 * DocTest/en.expected/System/Array.xml,
1766 DocTest/en.expected.since/System/Array.xml,
1767 DocTest/html.expected/System/Array.html,
1768 DocTest/en.expected.importecmadoc/System/Environment.xml,
1769 DocTest/en.expected.importecmadoc/System/Array.xml,
1770 DocTest/en.expected.importslashdoc/System/Array.xml: Added; expected
1771 output for System.Array type for various tests.
1773 2007-06-18 Wade Berrier <wberrier@novell.com>
1775 * monodocer.cs: Move assembly information up top because having it at the bottom
1776 fails to compile with mcs from trunk.
1778 2007-06-14 Jonathan Pryor <jonpryor@vt.edu>
1780 * monodocer.cs: Use XPathDocument instead of XmlDocument to process the ECMA
1781 documentation import. This cuts down a -type:System.Array import from
1782 ~15-20s to ~10-12s (not great, bug better). Fix importing of <exception/>
1783 elements -- previously we would skip them if the mono docs lacked them.
1785 2007-06-12 Jonathan Pryor <jonpryor@vt.edu>
1787 * monodocer.cs: The previous fix was buggy -- if the type parameters were
1788 renamed (ConvertAll<T,U> in ECMA, ConvertAll<TInput,TOutput> in Mono),
1789 then the existing element wouldn't be found, but the MemberInfo would.
1790 Result: duplicate XML elements (BOTH ConvertAll<T,U> AND
1791 ConvertAll<TInput,TOutput>), one of which is wrong, which clearly isn't
1792 desirable. If the Mono XML element can't be found, try looking it up
1793 based on the MemberInfo found from the ECMA docs to avoid duplication.
1795 2007-06-11 Jonathan Pryor <jonpryor@vt.edu>
1797 * monodocer.cs: Add support for renaming of template parameters (useful
1798 because ECMA 335 refers to Array.ConvertAll<T,U> while Mono/.NET have
1799 Array.ConvertAll<TInput,TOutput>). Not terribly intelligent, but smart
1800 enough that all but two System.Array members can now be imported (a
1801 private constructor, and a member with an incorrectly documented parameter
1802 type, neither of which I plan on supporting). Cleanup some of the
1803 `#if NET_1_0` blocks by using `using' aliases -- alas, requires moving the
1804 [assembly:...] attributes; see bugzilla #81855.
1806 2007-06-11 Jonathan Pryor <jonpryor@vt.edu>
1808 * monodocer.cs: Add support for explicity-implemented interface members.
1809 Minor cleanup. Replace catch(NotSupportedException){} blocks.
1810 * Makefile.am (clean): Cleanup monodocer.exe* files.
1811 * DocTest-v1.cs: Add IFoo<T>, explicitly implement some interfaces on
1812 MyList<A,B> to test explicitly-implemented member support.
1813 * DocTest/en.expected/index.xml,
1814 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1815 DocTest/en.expected.since/index.xml,
1816 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1817 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1818 DocTest/html.expected/Mono.DocTest.Generic/index.html,
1819 DocTest/html.expected/index.html,
1820 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
1821 DocTest/en.expected.importslashdoc/index.xml,
1822 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1823 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml:
1825 * DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
1826 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
1827 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1828 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html: Added.
1830 2007-05-29 Jonathan Pryor <jonpryor@vt.edu>
1832 * monodocer.cs: Invert ECMA documentation importing -- instead of iterating
1833 over the monodoc XML and importing ECMA docs as encountered (randomly),
1834 iterate over the ECMA docs in-order and access the monodoc types randomly.
1835 This significantly improves access as the ECMA docs are ~7.2MB in size,
1836 while the monodoc XML types 10's-100's of KB (randomly accessing a 7.2 MB
1837 XML document == BAD; randomly accessing a several hundred KB document is
1838 better). This cuts down a -type:System.Array import from ~4 minutes to
1839 < ~20s. Alas, it appears to miss a few members as well, so it's not done.
1841 2007-05-19 Jonathan Pryor <jonpryor@vt.edu>
1843 * monodocer.cs: Create diff(1)-friendly output for -importecmadocs.
1844 Previously, we'd remove <summary/>, <remarks/>, etc., and re-add them at
1845 the end of the <Docs/> node, which results in major changes for diff(1),
1846 so instead we replace the contents of existing elements when appropriate.
1847 Remove '\r' from the imported document (also to remove diff(1)-reported
1848 changes as the line endings would change).
1850 2007-05-17 Jonathan Pryor <jonpryor@vt.edu>
1852 * monodocer.cs: Add -importecmadoc flag, which will import
1853 documentation found within an ECMA documetation file (e.g. the
1854 CLILibraryTypes.xml from the ECMA-335 standard).
1855 WARNING: import is currently SLOW.
1857 2007-05-17 Jonathan Pryor <jonpryor@vt.edu>
1859 * monodocer.cs: Refactor MakeDocNode() so that there's only one
1860 version, not three overloads, and use a (new) DocsNodeInfo type to
1861 pass information to the new MakeDocNode() method. This doesn't
1862 change anything per-se, but it'll make it easier to pass new
1863 parameters to MakeDocNode() without making the rediculously long
1864 parameter list even longer...
1866 2007-05-12 Joshua Tauberer <jit@occams.info>
1868 * overview.xsl: Always sort type names, since when updating
1869 docs monodocer can make the list in index.xml out of order.
1870 * monodocer.cs: When deleting duplicate member entries, delay
1871 deletion until after loop is finished.
1872 * Makefile.am, DocTest-v1.cs, DocTest/en.expected.importslashdoc,
1873 DocTest/html.expected: Revise monodocs2html tests to use
1874 the /doc file so we can test those tags too. And changed two
1875 <c> tags to <see cref=/>.
1876 * stylesheet.xsl, DocTest/html.expected: Fix see-links to methods,
1877 which didn't recognize '(' as delimiting type from args, and
1878 display nice type names for arguments.
1880 2007-03-15 Lluis Sanchez Gual <lluis@novell.com>
1882 * monodocer.cs: When deleting a member, don't remove it from the
1883 parent xml element until all members are checked, since doing
1885 Properly import internal protected members.
1887 2006-12-29 Jonathan Pryor <jonpryor@vt.edu>
1889 * Makefile.am: Add check-monodocer-ignore_extra_docs-update,
1890 check-doc-tools-update, and check-update targets.
1891 * monodocer.cs: Fix generation of attribute parameters, as e.g.
1892 `AttributeUsage.Class|Struct' doesn't look right; it should
1893 instead be `AttributeUsage.Class | AttributeUsage.Struct'.
1894 * DocTest-v1.cs: Add new public Attribute with an AttributeUsage for tests.
1895 * DocTest/en.expected/index.xml,
1896 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
1897 DocTest/en.expected.importslashdoc/index.xml,
1898 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
1899 DocTest/en.expected.since/index.xml,
1900 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
1901 DocTest/html.expected/index.html,
1902 DocTest/html.expected/Mono.DocTest/index.html,
1903 DocTest/html.expected/Mono.DocTest/DocAttribute.html: Added; update
1904 expected output for new tests.
1906 2006-12-29 Jonathan Pryor <jonpryor@vt.edu>
1908 * monodocer.cs: Fix C# type name generation for nested types in the System
1909 namespace. Remove TypeCastException when dealing with custom attributes.
1910 * DocTest-v1.cs: Add System.Environment type for testing System handling.
1911 * DocTest/en.expected/index.xml, DocTest/en.expected/System.xml,
1912 DocTest/en.expected/System/Environment.xml,
1913 DocTest/en.expected/System/Environment+SpecialFolder.xml,
1914 DocTest/en.expected.since/index.xml, DocTest/en.expected.since/System.xml,
1915 DocTest/en.expected.since/System/Environment+SpecialFolder.xml,
1916 DocTest/en.expected.since/System/Environment.xml,
1917 DocTest/en.expected.importslashdoc/index.xml,
1918 DocTest/en.expected.importslashdoc/System.xml,
1919 DocTest/en.expected.importslashdoc/System/Environment.xml,
1920 DocTest/en.expected.importslashdoc/System/Environment+SpecialFolder.xml,
1921 DocTest/html.expected/index.html, DocTest/html.expected/System/index.html,
1922 DocTest/html.expected/System/Environment.html,
1923 DocTest/html.expected/System/Environment+SpecialFolder.html:
1924 Added; update expected output for new tests.
1926 2006-12-29 Jonathan Pryor <jonpryor@vt.edu>
1928 * monodocer.cs: `abstract sealed' classes are actually `static' classes.
1930 2006-12-27 Jonathan Pryor <jonpryor@vt.edu>
1932 * monodocer.cs: Re-order the attributes in <Type/> elements so that the
1933 ordering is (somewhat) well defined. This helps with `diff' output in
1934 ../class, as it prevents "false positives" when the attributes are
1935 re-ordered. Fix CSharpFullMemberFormatter.GetTypeDeclaration() so that
1936 when handling C# builtin types (e.g. System.Byte) it uses the real name in
1937 the declaration instead of the C# keyword (`class byte' is wrong).
1939 2006-12-26 Jonathan Pryor <jonpryor@vt.edu>
1941 * Makefile.am: Add check-monodocer-ignore_extra_docs test.
1942 * monodocer.cs: Fix -ignore_extra_docs. Previously, it would just ignore
1943 "missing" types, but it would still remove "missing" members.
1945 2006-12-26 Jonathan Pryor <jonpryor@vt.edu>
1947 * monodocer.cs: Don't insert internal attributes into the documentation.
1948 * DocTest-v1.cs: Add test for use of an internal attribute.
1950 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1952 * monodocer.cs: Don't include full namespace for System.* types. *Do*
1953 include the full namespace for nested System types, e.g.
1954 System.Collections.IEnumerable. This is what is currently in
1955 ../class/corlib/en, and making this change results in a smaller diff.
1956 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1957 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1958 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1959 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1960 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1961 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml:
1962 Update unit tests for above monodocer.cs change.
1964 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1966 * monodocer.cs: Don't include full namespace for System.* types. This is
1967 what ECMA-335 CLILibraryTypes.xml does for C# declarations -- no
1968 namespaces within e.g. inheritance lists or parameter lists for the System
1969 namespace and namespaces nested within System.
1970 Remove unnecessary console output.
1971 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1972 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1973 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1974 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1975 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1976 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml:
1977 Update unit tests for above monodocer.cs change.
1979 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1981 * monodocer.cs: Make sure that the types we document are *really* public.
1982 For some reason public nested types of internal types are returned by
1983 Assembly.GetTypes(), e.g. ``internal class A { public class B {} }''
1984 These types shouldn't be documented.
1985 * DocTest-v1.cs: Add test case for above.
1987 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1989 * monodocer.cs: Add -ignore_extra_docs flag; when set, it will not rename
1990 .xml files for types not found to .xml.remove. This is useful in ../class
1991 when we're processing assemblies multiple times for the 1.0 & 2.0
1992 profiles, as when processing the 1.0 profile we'll be "missing" the 2.0
1993 types, and we don't want those to be renamed.
1995 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1997 * Makefile.am: Add a monodocer1.exe target, which is a version of monodocer
1998 which runs under the 1.0 runtime. This is necessary so that we can still
1999 generate/update docs for mscorlib.dll 1.0 (as only one mscorlib.dll can
2000 ever be loaded into a process).
2001 * monodocer.cs: Split out the .NET 2.0 functionality so that it can be built
2002 for both 1.0 and 2.0 runtimes. 1.0 support is controlled by the
2005 2006-12-20 Jonathan Pryor <jonpryor@vt.edu>
2007 * monodocer.cs: Don't try too hard in UpdateParameters(). Previously, if a
2008 the number of parameters a method accepted changed from > 1 to 1, the
2009 "easy" <param/> handling would (inadvertently?) change all <param/>s to have
2010 the @name of the method's single parameter -- so if you _had_ parameters
2011 A, B, and C but the method now only has D, then A, B, and C would all have
2012 their @name attribute changed to D. Odd, but possibly acceptable...
2013 ...until we try to make sure that the <param/>s are in the right order, in
2014 which case we'll record the index of D as 0 (it's the 1st parameter), but
2015 find a parameter with a different index (the old B & C), causing us to
2016 reinsert the parameter to make sure it's in the proper order. This
2017 results in an infinite loop within System.Xml -- see Bugzilla #80331.
2018 It's safer to just ignore the extra parameters.
2020 2006-12-07 Jonathan Pryor <jonpryor@vt.edu>
2022 * DocTest-v1.patch: Add an operator returning a generic parameter (triggers
2023 error fixed in monodocer.cs).
2024 * DocTest-v2.patch: Update (due to changes in DocTest-v1.cs).
2025 * monodocer.cs: CSharpFullMemberFormatter.AppendVisibility() needs to accept null
2026 MethodBases (when called from GetEventDeclaration() and e.GetAddMethod()
2027 returns null); fix SlashDocMemberFormatter.GetMethodDeclaration() so that
2028 generic types can be the return value of methods. These changes allow
2029 generation of documentation on Mono's 2.0 mscorlib.dll.
2030 * stylesheet.xsl: Use GetParameterType() to emit the return type of
2031 explicit/implicit operators, as they can be/use generic arguments.
2032 * DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
2033 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
2034 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
2035 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
2036 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html:
2037 Flush to match current output.
2039 2006-11-22 Jonathan Pryor <jonpryor@vt.edu>
2041 * monodocer.cs: Don't generate documentation/prototypes for non-public
2042 property get/set accessors. Patch from Ivan N. Zlatev.
2044 2006-11-01 Jonathan Pryor <jonpryor@vt.edu>
2046 * monodocer.cs: When importing -importslashdoc documentation, convert
2047 <seealso/> elements into <altmember/> elements (as the former is the
2048 recommended element within ECMA-334, while the latter is the actual
2049 element used for our ECMA documentation).
2050 * DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml: Flush.
2052 2006-10-27 Jonathan Pryor <jonpryor@vt.edu>
2054 * stylesheet.xsl: Generate more correct string id's for "id" attribute
2055 values, so that string ids match the output of CSC.EXE 2.0. Changes:
2056 append ``N instead of `N for generic methods, and use the correct 0-based
2057 type parameter index, not a 1-based index.
2058 * DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
2059 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
2060 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
2061 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
2062 DocTest/html.expected/Mono.DocTest/UseLists.html: Flush.
2064 2006-10-24 Jonathan Pryor <jonpryor@vt.edu>
2066 * DocTest-v1.cs: Add /doc comments (for use with `make
2067 check-monodocer-importslashdoc`).
2068 * DocTest-v2.patch: Update (due to changes in DocTest-v1.cs).
2069 * Makefile.am: Add check-monodocer-importslashdoc,
2070 check-monodocer-importslashdoc-update targets.
2071 * monodocer.cs: Fix -importslashdoc. Massively refactor generation of
2072 strings from MemberInfos (Type, MethodInfo, etc.) so that commonalities
2073 between DocType, C#, and /doc string IDs can be shared and easily
2074 customized (as opposed to dealing with the > 100 line FillDocTypeName()
2075 method, which was already too complex).
2076 * DocTest/en.expected.importslashdoc/index.xml,
2077 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic.xml,
2078 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
2079 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
2080 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
2081 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
2082 DocTest/en.expected.importslashdoc/Mono.DocTest.xml,
2083 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
2084 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
2085 DocTest/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
2086 DocTest/en.expected.importslashdoc/Mono.DocTest/IProcess.xml,
2087 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass.xml,
2088 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
2089 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
2090 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
2091 DocTest/en.expected.importslashdoc/Mono.DocTest/Color.xml,
2092 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml:
2093 Added; expected output for `make check-monodocer-importslashdoc'.
2095 2006-10-19 Jonathan Pryor <jonpryor@vt.edu>
2097 * Makefile.am: Change check-monodocer target to add a `monodocer -namespace'
2098 check, as `-namespace' would use a bad filename generation algorithm.
2099 * monodocer.cs: Don't use Type.Name (or equivalent) to generate filenames,
2100 but use GetTypeFileName(), so that Foo<T> only tries to open the file
2101 Foo`1, instead of the file Foo<T> which (1) is wrong, we never generate
2102 filenames like that, and (2) fails horribly on Win32 (as '<' and '>' are
2103 invalid path characters).
2105 2006-10-19 Jonathan Pryor <jonpryor@vt.edu>
2107 * monodocer.cs: Sort member ordering so that when the order of members
2108 returned by Type.GetMembers() changes (as it did between 1.1.17 and
2109 1.1.18) the order of the documentation members won't change (leading to
2110 "errors" in the regression tests).
2111 * DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
2112 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
2113 DocTest/en.expected/Mono.DocTest/Widget.xml,
2114 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
2115 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
2116 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
2117 DocTest/en.expected/Mono.DocTest/UseLists.xml,
2118 DocTest/en.expected/Mono.DocTest/Color.xml,
2119 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
2120 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
2121 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
2122 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
2123 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
2124 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
2125 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
2126 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
2127 DocTest/en.expected.since/Mono.DocTest/Color.xml,
2128 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
2129 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
2130 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
2131 DocTest/html.expected/Mono.DocTest/Color.html,
2132 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
2133 DocTest/html.expected/Mono.DocTest/Widget.html,
2134 DocTest/html.expected/Mono.DocTest/DocValueType.html,
2135 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
2136 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
2137 DocTest/html.expected/Mono.DocTest/UseLists.html: Flush. Since monodocer
2138 generates a different member ordering, *everything* gets a different
2141 2006-10-12 Jonathan Pryor <jonpryor@vt.edu>
2143 * monodocer.cs: Add support for inserting Docs/since element. This element
2144 is *only* inserted for NEW type/members, never updated, and is only
2145 inserted if the -since:SINCE command-line argument is provided.
2146 * DocTest.cs: Renamed to DocTest-v1.cs.
2147 * Makefile.am: Add DocTest.dll-v1, DocTest.dll-v2, check-monodocer-since,
2148 check-monodocer-since-update, check targets.
2149 * DocTest-v2.patch: Patch file applied to DocTest-v1.cs to get DocTest.dll
2151 * DocTest/en.expected.since/index.xml,
2152 DocTest/en.expected.since/Mono.DocTest.xml,
2153 DocTest/en.expected.since/Mono.DocTest/AddedType.xml,
2154 DocTest/en.expected.since/Mono.DocTest/Color.xml,
2155 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
2156 DocTest/en.expected.since/Mono.DocTest/IProcess.xml,
2157 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
2158 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
2159 DocTest/en.expected.since/Mono.DocTest/Widget+Del.xml,
2160 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
2161 DocTest/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
2162 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
2163 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
2164 DocTest/en.expected.since/Mono.DocTest.Generic.xml,
2165 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
2166 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
2167 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
2168 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml: Added;
2169 expected output for DocTest.dll v2.0.0.0.
2171 2006-10-11 Jonathan Pryor <jonpryor@vt.edu>
2173 * stylesheet.xsl: Add /Members/Docs node in GetInheritedMembers() so that
2174 GetLinkId() sees typeparam elements for type replacement in parameters for
2175 members of base types. Make sure that "simple" type arguments are
2176 replaced, e.g. T --> `1.
2177 TODO: figure out type replacements for nested types.
2178 * DocTest/html.expected/Mono.DocTest/UseLists.html,
2179 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
2180 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
2181 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
2182 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Change link id's
2183 and targets for proper type replacements within parameters.
2185 2006-10-10 Joshua Tauberer <jit@occams.info>
2187 * monodocer.cs: Fixed a bug in WriteElement that would put
2188 nodes in the wrong place if some node in the path already
2190 - To prevent TypeParameters from always being put at the
2191 end on an update, don't delete that node in an update, just
2193 - Update the DisplayName attribute in index.xml on doc updates.
2194 * DocTest/*: Updated for the DisplayName fix, and also put
2195 into a pristine state (I had committed them as an update,
2196 which put the TypeParameters block at the end of the files.)
2198 2006-10-09 Joshua Tauberer <jit@occams.info>
2200 * monodocer.cs: Update a type's name attributes during an update
2201 because generic argument names may change even if filename
2203 - Added a Type/TypeParameters section which includes type
2204 parameters that come from the declaring type, for nested types.
2205 - When inheriting from a generic type, added a BaseTypeArguments
2206 section which maps type parameters on the base type's type
2207 definition to types instantiating those parameters. i.e.:
2209 class Y<U> : X<U> { }
2210 Y gets a mapping in its BaseType node from T to U.
2211 * stylesheet.xsl: Don't attempt to link to a generic type
2212 parameter, just display it in italics. And when displaying
2213 inherited members, try to replace generic type parameters
2214 in the base type with the types that have instantiated them
2216 * The DocTests are updated to show off these things.
2218 2006-10-08 Joshua Tauberer <jit@occams.info>
2220 * monodocer.cs: Track which members have been seen in the XML file
2221 not by putting MemberInfos into a hashtable, which seems to
2222 not always work right, but instead by their (string) signature.
2223 - Get custom attribute data with the new 2.0 CustomAttributeData
2224 classes, so that we can reconstruct what the constructor actually
2226 - Hide System.Runtime.InteropServices.Out attributes since it is
2227 fake and already in the RefType XML attribute.
2228 - Structs weren't getting their interfaces listed in their C# type
2230 * monodocs2html.cs: Don't override the default XSLT URI resolver anymore.
2231 * stylesheet.xsl: Get the index.xml document at the start while we're
2232 sure we have the right base path (the XML document being transformed).
2233 - Display inherited members in a type's member list when the base type
2234 is documented in the same monodocer document set.
2235 - Make sure there's a space between a method's parameters and return
2236 value type in the member list.
2237 * DocTest: Updated to test these things.
2239 2006-10-06 Jonathan Pryor <jonpryor@vt.edu>
2241 * overview.xsl: When generating a Namespace/index.html file, we should
2242 insert the namespace remarks as well. (This *should* have been done, but
2243 the remarks selection was relative to '.', not to the provided $ns. :-(
2244 * DocTest/html.expected/Mono.DocTest.Generic/index.html,
2245 DocTest/html.expected/Mono.DocTest/index.html: Flush.
2247 2006-10-06 Jonathan Pryor <jonpryor@vt.edu>
2249 * Makefile.am: Fix -update targets so they don't delete .svn/*.
2250 * monodocer.cs: Don't key off of DisplayName to insert new <Type> elements,
2251 as this will result in updating all existing documentation (rather silly).
2252 Key off of Name instead, and only create a DisplayName attribute if it
2254 * DocTest/en.expected/index.xml: Update to latest monodocer output.
2255 * monodocs2html.cs: If DisplayName doesn't exist, fall back to
2256 Name ("legacy" behavior, now made current due to change in monodocer.cs).
2257 * stylesheet.xsl: For "Name [Generic ] [MemberType]" descriptions, make the
2258 2nd space part of "Generic". Otherwise we get double spaces for
2259 non-generic members, e.g. "Name [MemberType]".
2260 * overview.xsl: Fallback to @Name if @DisplayName doesn't exist.
2261 * DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
2262 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
2263 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
2264 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
2265 DocTest/html.expected/Mono.DocTest/Widget.html,
2266 DocTest/html.expected/Mono.DocTest/DocValueType.html,
2267 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
2268 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
2269 DocTest/html.expected/Mono.DocTest/UseLists.html: Update to latest
2270 monodocs2html output.
2272 2006-10-06 Jonathan Pryor <jonpryor@vt.edu>
2274 * Makefile.am: Build with gmcs; add `-debug' to compile lines; add
2275 DocTest.dll, check-monodocer, check-monodocer-update, check-monodocs2html/
2276 check-monodocs2html-update targets for unit tests.
2277 * monodocer.cs: Major overhaul for Generics support. Documentation
2278 generated follows the pattern used in CLILibraryTypes.xml from ECMA-335.
2279 - Remove some warnings about unused variables.
2280 - Don't assume that Type.FullName is always what we want, but instead
2281 build a C# typename from the Type information. This is needed to nicely
2282 deal with generics, as the FullName for Foo<int> would be
2283 Foo[[System.Int32, mscorlib]], while we really want Foo<int>.
2284 - For index.xml files, insert a File attribute, as the Type name won't
2285 match the filename for generic types (Foo<T> is the file Foo`1.xml).
2286 - For GetMember(), remove generic parameters before using Type.GetMember()
2287 with the member name.
2288 - Code refactoring so that <param/> and <typeparam/> generation & updating
2290 - Properly use `this' for method name on indexers.
2291 * monodocs2html.cs: Add Generics support -- use the @File attribute instead
2292 of assuming that @Name contains the proper filename.
2293 * defaulttemplate.xsl: Use <h1> instead of <div>; add CSS for
2294 `.InnerSignatureTable tr' and `.TypePermissionTable tr'.
2295 * overview.xsl: If there are fewer than $max-types (20) types in the
2296 assembly, show them all in the top-level index.html, no matter how many
2297 namespaces are present. Otherwise, provide links to the
2298 Namespace/index.html files, so that things don't suddenly look different
2299 as soon as you go from 1 namespace to > 1 namespaces in an assembly.
2300 Use <h2/> instead of <div/>.
2301 * stylesheet.xsl: Major overhaul for Generics support, some re-indentation.
2302 - Use <h2/>...<h4/> instead of <div/>
2303 - Allow output to validate against XHTML.
2304 - Don't use generate-id(), but instead generate member ID's manually so
2305 that we can properly refer to them from outside the current page.
2306 - Add support for <see cref=""/> translation to non-types --
2307 constructors, methods, properties, fields, events. These can refer to
2308 members from a different file, since generate-id() is no longer used.
2309 - Update the mono-docs site so links to System.* types work.
2310 - Add support for additional Mono.* namespaces on the mono-docs site.
2311 - Properly display C# indexers ("type this [params]", not
2312 "type Item [params]").
2313 - Generate documentation for <typeparam/> elements.
2314 * DocTest.cs: Added; Source for DocTest.dll, used by unit tests.
2315 * DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
2316 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
2317 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
2318 DocTest/html.expected/Mono.DocTest/DocValueType.html,
2319 DocTest/html.expected/Mono.DocTest/IProcess.html,
2320 DocTest/html.expected/Mono.DocTest/index.html,
2321 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
2322 DocTest/html.expected/Mono.DocTest/Color.html,
2323 DocTest/html.expected/Mono.DocTest/Widget+Del.html,
2324 DocTest/html.expected/Mono.DocTest/UseLists.html,
2325 DocTest/html.expected/Mono.DocTest/Widget.html,
2326 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
2327 DocTest/html.expected/Mono.DocTest.Generic/index.html,
2328 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
2329 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
2330 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
2331 DocTest/html.expected/index.html,
2332 DocTest/en.expected/Mono.DocTest.Generic.xml,
2333 DocTest/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
2334 DocTest/en.expected/Mono.DocTest/IProcess.xml,
2335 DocTest/en.expected/Mono.DocTest/Widget.xml,
2336 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
2337 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
2338 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
2339 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
2340 DocTest/en.expected/Mono.DocTest/Widget+Del.xml,
2341 DocTest/en.expected/Mono.DocTest/UseLists.xml,
2342 DocTest/en.expected/Mono.DocTest/Color.xml,
2343 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
2344 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
2345 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
2346 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
2347 DocTest/en.expected/index.xml, DocTest/en.expected/Mono.DocTest.xml:
2348 Added. Expected output for monodocer (en.expected) and
2349 monodocs2html (html.expected).
2351 2006-04-01 Joshua Tauberer <tauberer@for.net>
2353 * monodocs2html.cs: Skip files that are missing.
2355 2006-03-09 Joshua Tauberer <tauberer@for.net>
2357 * monodocer.cs: Reverted all of the Cecil changes. Ah well.
2359 2006-03-04 Joshua Tauberer <tauberer@for.net>
2361 * monodocer.cs: Using Cecil now! (Some Cecil fixes
2362 need to be committed.)
2364 2006-03-03 Joshua Tauberer <tauberer@for.net>
2366 * monodocer.cs: Don't change up whitespace unless user says so.
2367 That makes it hard to see differences against svn.
2369 2006-01-12 Jonathan Pryor <jonpryor@vt.edu>
2371 * bsd-man-to-ecma.pl, bsd-man-to-exception.pl: Added; scripts to help
2372 convert BSD man pages into ECMA XML formats. Run `perldoc PROGRAM` for
2373 program documentation.
2374 * Makefile.am: Add bsd-man-to-ecma.pl and bsd-man-to-exception.pl to
2377 2005-08-11 Dan Winship <danw@novell.com>
2379 * monodocer.cs: Don't preserve whitespace when reading the old
2380 doc, and don't add any whitespace when creating the new doc. Just
2381 let the XmlTextWriter handle indentation and it will all just
2384 2005-08-03 Atsushi Enomoto <atsushi@ximian.com>
2386 * monodocer.cs : update name attribute in paramref elements in sync
2387 with that of param element.
2389 2005-07-09 Joshua Tauberer <tauberer@for.net>
2391 From Rodolfo Campero <rodolfo.campero@gmail.com>
2393 * monodocs2slashdoc.cs: Updated for changes in
2394 index.xml for documenting multiple assemblies.
2395 This app now writes out XML files for each assembly
2396 as well as NamespaceSummaries.xml to the working
2399 2005-06-12 Joshua Tauberer <tauberer@for.net>
2401 * monodocer.cs: Added --importslashdoc option to
2402 import the contents of /doc-generated xml docs
2403 into the generated files.
2405 2005-06-09 Joshua Tauberer <tauberer@for.net>
2407 * monodocer.cs : When documenting a single assembly,
2408 default the Title in index.xml to the name of the
2411 2005-06-04 Eric Butler <eric@extremeboredom.net>
2413 (copied from ChangeLog in parent directory)
2415 - Now exits with an exit code of 1 in the event of an error
2416 - Added '-name' command line argument
2417 - Use above argument for <Title> element
2419 2005-06-01 Joshua Tauberer <tauberer@for.net>
2421 * monodocer.cs : Old index.xml files need to have new nodes
2422 created for multiple assemblies, and the old Assembly and
2423 Attributes nodes removed. Added a Title element for 2html.
2425 * overview.xsl : Revised monodocs2html to use the Title
2426 element in index.xml for page titles, rather than the
2427 assembly name, which isn't available anymore since there
2428 may be more than one assembly.
2430 2005-05-23 Mike Kestner <mkestner@novell.com>
2432 * monodocer.cs : add multiple assembly updating.
2434 2005-05-09 Joshua Tauberer <tauberer@for.net>
2436 * Thanks for pushing me to use a ChangeLog.
2437 * Disallow documenting types in the root namespace (type.Namespace ==
2439 * When a <code> tag has a 'src' attribute, monodocer will replace
2440 the contents of the element with the text in the indicated file.
2441 the path is relative to the path given as the --path option.
2442 * Properties that have different access modifiers on their accessors
2443 are now given signatures that reflect that. (But Monodoc doesn't
2444 recognize this properly. A format change is needed.)
2445 * monodocs2html: Create the destination directory if it doesn't exist.
2447 2005-01-29 Jonathan Pryor <jonpryor@vt.edu>
2450 * monodocer.cs (GetTypeFileName): Add check for type.Namespace == null.
2451 Fixes NullReferenceException when trying to update Mono.Posix.dll.