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