1 2008-10-27 Jonathan Pryor <jpryor@novell.com>
3 * Makefile: Fix build error caused by filenames containing '`'.
5 2008-10-27 Jonathan Pryor <jpryor@novell.com>
7 * Mono.Documentation/mdoc.cs: TraceLevel.Error messages should go to
8 Console.Error, as per Unix convention.
9 * Makefile: cehck-mdoc-validate* needs to also capture standard error.
11 2008-10-27 Jonathan Pryor <jpryor@novell.com>
13 * Mono.Documentation/validate.cs: Remove warnings
14 * Test/validate.check.monodocer, Test/validate.check.monodocer.since:
15 Don't generate output if no errors are found.
16 * Test/validate.check.monodocer.importslashdoc: Prefix error messages
17 with "mdoc:", as per Unix convention.
19 2008-10-24 Jonathan Pryor <jpryor@novell.com>
21 * Makefile: Fixup mdoc.exe dependencies so that it's rebuilt if the
22 resources or monodoc.dll change. Add tests for mdoc-validate.
23 * Mono.Documentation/assembler.cs, Mono.Documentation/mdoc.cs,
24 Mono.Documentation/monodocer.cs, Mono.Documentation/monodocs2html.cs,
25 Mono.Documentation/monodocs2slashdoc.cs,
26 Mono.Documentation/validate.cs:
27 - Major rearchitecture; instead of having the option parsing
28 centralized within mdoc.cs, keep option parsing within the relevant
30 - Introduce the MDocCommand abstract class to serve as the base class
31 -- primarily done to introduce the new Message() and Error()
32 methods, in which Message() will only show the message if the
33 current message level is >= the message's level (thus minimizing
34 console spew); see ../monodoc for more details.
35 - Add `-v' ("verbose") top-level argument to allow setting/adding
36 levels, so that `mdoc -v -v assemble ...` will show *all*
37 assemble-associated messages (which can be quite voluminous).
38 - Remove compiler warnings, when able.
39 * Mono.Documentation/XhtmlWriter.cs: Remove warning about unused
41 * Resources/monodoc-ecma.xsd: Extend the XSD to support more
42 elements/attributes on various elements -- e.g. mdoc-update looks
43 for a //code/@src attribute, which wasn't defined in the XSD. Oops.
44 * Test/validate.check.monodocer.importslashdoc: Flush (due to above
47 2008-10-22 Jonathan Pryor <jpryor@novell.com>
49 * Makefile: Correct path names.
50 * Mono.Documentation/monodocer.cs: Better support nested types.
51 * Test/DocTest-v1.cs: Add 4 levels of nested types.
52 * Test/en.expected.importslashdoc/index.xml,
53 Test/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
54 Test/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass+Double+Triple+Quadruple.xml,
55 Test/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass+Double+Triple.xml,
56 Test/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass+Double.xml,
57 Test/en.expected.since/index.xml,
58 Test/en.expected.since/Mono.DocTest/Widget.xml,
59 Test/en.expected.since/Mono.DocTest/Widget+NestedClass+Double+Triple+Quadruple.xml,
60 Test/en.expected.since/Mono.DocTest/Widget+NestedClass+Double+Triple.xml,
61 Test/en.expected.since/Mono.DocTest/Widget+NestedClass+Double.xml,
62 Test/en.expected/index.xml,
63 Test/en.expected/Mono.DocTest/Widget.xml,
64 Test/en.expected/Mono.DocTest/Widget+NestedClass+Double+Triple+Quadruple.xml,
65 Test/en.expected/Mono.DocTest/Widget+NestedClass+Double+Triple.xml,
66 Test/en.expected/Mono.DocTest/Widget+NestedClass+Double.xml,
67 Test/html.expected/index.html,
68 Test/html.expected/Mono.DocTest/index.html,
69 Test/html.expected/Mono.DocTest/Widget.html,
70 Test/html.expected/Mono.DocTest/Widget+NestedClass+Double+Triple+Quadruple.html,
71 Test/html.expected/Mono.DocTest/Widget+NestedClass+Double+Triple.html,
72 Test/html.expected/Mono.DocTest/Widget+NestedClass+Double.html,
73 Test/msxdoc-expected.importslashdoc.xml: Flush.
75 2008-10-17 Jonathan Pryor <jpryor@novell.com>
77 * Makefile: Reference the monodoc.dll from the net_1_1 profile, as
78 that's the only one that will get built.
80 2008-10-17 Jonathan Pryor <jpryor@novell.com>
82 * Makefile: Fix $(EXTRA_DISTFILES) so that `make distcheck` doesn't
83 fail on mdoc anymore...
85 2008-10-18 Raja R Harinath <harinath@hurrynot.org>
87 * Makefile (MCS1): Use 'class/lib/net_1_1', not 'class/lib/1.0'.
89 2008-10-17 Jonathan Pryor <jpryor@novell.com>
91 * Mono.Documentation/monodocer.cs: -overrides & -pretty should default
92 to true. (Not a major change, as mdoc.exe already did this, so it
93 really only impacts monodocer1.exe, which is internal...)
95 2008-10-17 Jonathan Pryor <jpryor@novell.com>
97 * Mono.Documentation/monodocer.cs: Only provide a Main() method and
98 use Mono.GetOptions when targeting .NET 1.0 (i.e. monodocer1.exe).
100 2008-10-16 Jonathan Pryor <jpryor@novell.com>
102 Migration from monodoc/tools to mcs/tools/mdoc...
104 * . (svn:ignore), Test (svn:ignore): Ignore generated files.
105 * assembler.cs, mdoc.cs, monodocer.cs, monodocs2html.cs,
106 monodocs2slashdoc.cs, normalize.cs, validate.cs, XhtmlWriter.cs:
107 Move to Mono.Documentation.
108 * defaulttemplate.xsl, overview.xsl, stylesheet.xsl: Moved to
110 * DocTest: Moved to Test.
111 * DocTest-v1.cs, DocTest-v2.patch, TestEcmaDocs.xml: Moved to Test.
112 * mdoc.exe.sources: Added; mcs include file to build mdoc.exe.
113 * Makefile: Added; build mdoc.exe, monodocer1.exe, and unit tests for
115 * Mono.Documentation/assembler.cs, Mono.Documentation/normalize.cs,
116 Mono.Documentation/mdoc.cs, Mono.Documentation/monodocs2slashdoc.cs,
117 Mono.Documentation/monodocs2html.cs, Mono.Documentation/validate.cs:
118 Modify command line handling to remove Mono.GetOptions dependency.
119 * Test/DocTest-v1.cs: Update //code/@src attribute due to changed paths.
120 * Test/msxdoc-expected.importslashdoc.xml,
121 * Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml: Flush
122 due to above DocTest-v1.cs change.
124 2008-10-16 Jonathan Pryor <jpryor@novell.com>
126 * monodocer.cs: Fixup sorting of explicitly-implement generic members.
127 This keeps members from "bouncing around" in random orders when
128 updating documentation...
129 * DocTest-v1.cs: Explicitly implement some generic interface members on
130 MyList<A,B> to provoke the bug fixed above.
131 Dictionary<K,V>.ValueCollection in mscorlib was the original
133 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
134 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
135 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
136 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
137 DocTest/msxdoc-expected.importslashdoc.xml: Flush.
139 2008-10-15 Jonathan Pryor <jpryor@novell.com>
141 * monodocer.cs: Ignore some attributes, because they're ~meaningless
142 for documentation purposes (e.g. who cares if we need attributes to
143 represent decimal constants, or that a method shouldn't be stepped
144 into with the debugger, or...).
145 * DocTest/en.expected/index.xml,
146 * DocTest/en.expected/Mono.DocTest/Widget.xml,
147 * DocTest/en.expected/Mono.DocTest.Generic/Extensions.xml,
148 * DocTest/en.expected.since/index.xml,
149 * DocTest/en.expected.since/Mono.DocTest/Widget.xml,
150 * DocTest/en.expected.since/Mono.DocTest.Generic/Extensions.xml,
151 * DocTest/html.expected/Mono.DocTest/Widget.html,
152 * DocTest/html.expected/Mono.DocTest.Generic/Extensions.html,
153 * DocTest/en.expected.importslashdoc/index.xml,
154 * DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
155 * DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Extensions.xml:
158 2008-10-05 Jonathan Pryor <jpryor@novell.com>
160 * monodocer.cs: When sorting <Member/> elements elements, take generic
161 type parameters into account, so that methods with the same number
162 of type parameters are sorted together, instead of strewn across the
163 file according to the full //Member/@MemberName comparison.
164 * DocTest/**: Flush (and wtf is with the [DebuggerHidden] appearance?).
166 2008-09-19 Jonathan Pryor <jpryor@novell.com>
168 * DocTest-v1.cs: Add a member with a "deeply nested" generic parameter
169 list, so test the mdoc-html-utils.xsl fix.
170 * DocTest/msxdoc-expected.importslashdoc.xml,
171 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
172 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
173 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
174 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Flush.
176 2008-09-16 Jonathan Pryor <jpryor@novell.com>
178 * monodocer.cs: FieldInfo.GetValue() may throw, particularly if getting
179 the value of a public+static+readonly field, and the constructor for
180 the type of said field throws an exception (though DocTest-v1.cs has
181 a similar scenario). This is bad, as it prevents monodocer from
182 completing its work. Found by Dan Morgan.
183 * DocTest-v1.cs: Create a `public static readonly` field that will
184 generate an exception from the class constructor.
185 * DocTest/en.expected/Mono.DocTest/Widget.xml,
186 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
187 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
188 DocTest/html.expected/Mono.DocTest/Widget.html,
189 DocTest/msxdoc-expected.importslashdoc.xml: Flush.
191 2008-09-16 Jonathan Pryor <jpryor@novell.com>
193 * monodocer.cs: Allow #region/#endregion parsing to cope with blank lines.
195 2008-09-15 Jonathan Pryor <jpryor@novell.com>
197 * monodocer.cs: Strip off leading whitespace up to the indent level that
198 #region was found. This allows controlling how much leading whitespace is
199 preserved within the documentation (as too much whitespace will cause the
200 code to be indented significantly when rendered to e.g. html).
201 * DocTest-v1.cs: Indent the #region, to test the above.
202 * DocTest/msxdoc-expected.importslashdoc.xml,
203 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
204 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml:
207 2008-09-15 Jonathan Pryor <jpryor@novell.com>
209 * monodocer.cs: Allow //code/@src to include an anchor, in which the
210 anchor specifies a #region to include, instead of including the
211 entire document. This is currently limited to C# code. For example,
212 `<code lang="C#" src="foo.cs#Text"/>` would look insert all text
213 between `#region Text` and `#endregion` within foo.cs.
214 * DocTest-v1.cs: Add a #region, <code/> block to test the above.
215 * DocTest/msxdoc-expected.importslashdoc.xml,
216 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
217 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml:
220 2008-09-11 Jonathan Pryor <jpryor@novell.com>
222 * stylesheet.xsl: Post-process $cref so that we can use "nice"
223 //see/@cref strings that can actually refer to the right member.
224 For example, `<see cref="P:Foo.Bar{T}.Baz"/>` is needed to get a
225 nicely rendered "Foo.Bar<T>.Baz" link text, but previously it
226 wouldn't link to anything -- you'd need
227 `<see cref="P:Foo.Bar`1.Baz"/>` to get a functioning link for HTML
228 output. This now works.
230 2008-09-04 Jonathan Pryor <jpryor@novell.com>
232 * monodocer.cs: You can't use FieldInfo.GetValue() on generic types.
233 * DocTestv1.cs: Add checks for static fields on generic types.
236 2008-09-04 Jonathan Pryor <jpryor@novell.com>
238 * monodocer.cs: Clear out existing <value/> elements when import XML
239 documentation which also contains a <value/> element. (This keeps us from
240 getting multiple duplicate <value/> elements every time we update while
243 2008-08-31 Jonathan Pryor <jpryor@novell.com>
245 * DocTest-v1.cs: Update XML doc comment to mention correct cref.
246 * monodocer.cs: Further fixup XML documentation import and import the actual
247 *contents* of the <exception/> element (oops). Add support for importing
248 XML documentation for explicitly implemented interface members (CSC-style,
251 2008-08-27 Jonathan Pryor <jpryor@novell.com>
253 * monodocer.cs: Fixup XML documentation import to be more consistent with
254 ECMA XML import. In particular, this fixes <exception/> import so that
255 the same element isn't imported multiple times, leading to duplicate
256 <exception/> elements the more often monodocer is run.
257 * DocTest/msxdoc-expected.importslashdoc.xml,
258 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml: Flush.
259 Changes order of imported XML to reflect the original element order.
261 2008-08-11 Jonathan Pryor <jpryor@novell.com>
263 * monodocer.cs: Build fix (gmcs doesn't like using-alias-directives to
264 private nested types anymore).
266 2008-05-06 Wade Berrier <wberrier@novell.com>
268 * Makefile.am: Add Options.cs to EXTRA_DIST
270 2008-04-22 Jonathan Pryor <jpryor@novell.com>
272 * DocTest/en.expected/Mono.DocTest.Generic/Func`2.xml,
273 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Func`2.xml,
274 DocTest/en.expected.since/Mono.DocTest.Generic/Func`2.xml,
275 DocTest/html.expected/Mono.DocTest.Generic/Func`2.html: Flush: n377596
276 got fixed, so we can now retrieve custom attributes on all generic type
279 2008-04-15 Jonathan Pryor <jpryor@novell.com>
281 * . (svn:ignore): ignore generated files.
282 * Makefile.am: Add XmlDocUtils.cs to the build. Add unit tests for
283 monodocs2slashdoc; other monodocs2slashdoc changes.
284 * mdoc.cs: Update the arguments accepted by monodocs2slashdoc.
285 * monodocs2slashdoc.cs: Move DocUtils class into ../engine/XmlDocUtils.cs.
286 Add support for a -o parameter which contains all output (if specified).
288 - Add special support for extension methods -- index.xml now contains an
289 /Overview/ExtensionMethods element which contains ExtensionMethod
290 elements for all extension methods within all assemblies processed.
291 - The <ExtensionMethod/> element contains a subset of the <Member/> of the
292 actual extension method (and thus will contain a useful subset of the
293 documentation the source <Member/> contains), along with a <Targets/>
294 element describing all types the extension method applies to.
295 - Consequently, if you edit the documentation of your extension method,
296 you need to re-run monodocer to get the newly written documentation
297 inserted into index.xml.
298 - //Parameter/@RefType is "overloaded" to contain the "this" modifier of
299 extension methods (as this was easiest within mdoc-html-utils.xsl).
300 - Within CSharpMemberFormatter, insert generic type constraints for
301 methods. (Previously constraints were only done on types due to an
303 * monodocs2html.cs: Before rendering documentation via the XSLT, insert any
304 extension methods applicable to the type so that the extension methods
306 * DocTest-v1.cs: Add a class providing extension methods.
307 * stylesheet.xsl: Extension methods shouldn't be documented within the type,
308 just declared (and linked to the actual type's documentation).
309 * DocTest/msxdoc-expected.importslashdoc.xml: Added; expected output for
310 monodocs2slashdoc unit test.
311 * DocTest/en.expected/index.xml,
312 DocTest/en.expected/Mono.DocTest/UseLists.xml,
313 DocTest/en.expected/Mono.DocTest.Generic/Extensions.xml,
314 DocTest/en.expected/Mono.DocTest.Generic/Func`2.xml,
315 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
316 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
317 DocTest/en.expected.since/index.xml,
318 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
319 DocTest/en.expected.since/Mono.DocTest.Generic/Extensions.xml,
320 DocTest/en.expected.since/Mono.DocTest.Generic/Func`2.xml,
321 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
322 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
323 DocTest/en.expected.importslashdoc/index.xml,
324 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
325 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Extensions.xml,
326 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Func`2.xml,
327 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
328 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
329 DocTest/html.expected/index.html,
330 DocTest/html.expected/NoNamespace.html,
331 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
332 DocTest/html.expected/Mono.DocTest/DocValueType.html,
333 DocTest/html.expected/Mono.DocTest/IProcess.html,
334 DocTest/html.expected/Mono.DocTest/UseLists.html,
335 DocTest/html.expected/Mono.DocTest/Widget.html,
336 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
337 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
338 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
339 DocTest/html.expected/Mono.DocTest.Generic/index.html,
340 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
341 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.html,
342 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
343 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
344 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
345 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
346 DocTest/html.expected/System/Array.html: Flush; also contains additional
347 <Attributes/> elements on generic type parameters due to a mono fix.
349 2008-04-09 Jonathan Pryor <jpryor@novell.com>
351 * DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html: Fix the
352 System.EventHandler link.
354 2008-04-08 Jonathan Pryor <jpryor@novell.com>
356 * DocTest-v1.cs: Add more attributes, generic constraints to further test
358 * Makefile.am: Add check-md-html-dir target to help with testing
359 monodocs2html w/o re-generating the DocTest/en.actual directory.
360 * monodocer.cs: Lots of changes:
361 - Format change: /Type/TypeParameters/TypeParameter doesn't store the type
362 parameter name as it's value (e.g. <TypeParameter>A</TypeParameter>),
363 but instead stores the name as an attribute (e.g.
364 <TypeParameter Name="A" />). This was done as Generic Arguments can
365 contain both constraints and attributes which were previously
367 - Record constraints under a //TypeParameter/Constraints element, and
368 attributes under a //TypeParameter/Attributes element.
369 - Generic arguments for methods are now recorded in a
370 /Type/Members/Member/TypeParameters element, with the same schema as
371 type-level arguments.
372 - Properly insert the [return:...] attributes on delegates.
373 - Modify CSharpFullMemberFormatter to generate generic argument
374 constraints on type and member signatures.
375 - Note: attributes are currently not inserted due to n#322399.
376 * stylesheet.xsl: Properly escape generic type names so that all anchors
377 are modeled after ECMA-334 CREFs, e.g. T:Foo.Bar`1, not T:Foo.Bar<T>.
378 * DocTest/en.expected/index.xml,
379 DocTest/en.expected/Mono.DocTest/UseLists.xml,
380 DocTest/en.expected/Mono.DocTest/Widget.xml,
381 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
382 DocTest/en.expected/Mono.DocTest.Generic/Func`2.xml,
383 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
384 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
385 DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
386 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
387 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
388 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
389 DocTest/en.expected/System/Action`1.xml,
390 DocTest/en.expected/System/Array.xml,
391 DocTest/en.expected.since/index.xml,
392 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
393 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
394 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
395 DocTest/en.expected.since/Mono.DocTest.Generic/Func`2.xml,
396 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
397 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
398 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
399 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
400 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
401 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
402 DocTest/en.expected.since/System/Action`1.xml,
403 DocTest/en.expected.since/System/Array.xml,
404 DocTest/en.expected.importecmadoc/System/Action`1.xml,
405 DocTest/en.expected.importecmadoc/System/Array.xml,
406 DocTest/en.expected.importslashdoc/System/Array.xml,
407 DocTest/en.expected.importslashdoc/System/Action`1.xml,
408 DocTest/en.expected.importslashdoc/index.xml,
409 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
410 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
411 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
412 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
413 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
414 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/Func`2.xml,
415 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
416 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
417 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
418 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
419 DocTest/html.expected/index.html,
420 DocTest/html.expected/Mono.DocTest/Widget.html,
421 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
422 DocTest/html.expected/Mono.DocTest/UseLists.html,
423 DocTest/html.expected/Mono.DocTest.Generic/index.html,
424 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
425 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.html,
426 DocTest/html.expected/Mono.DocTest.Generic/Func`2.html,
427 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
428 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
429 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
430 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
431 DocTest/html.expected/System/Action`1.html,
432 DocTest/html.expected/System/Array.html: Flush.
434 2008-04-04 Jonathan Pryor <jpryor@novell.com>
436 * DocTest-v1.cs: Add nested generic type for testing.
437 * DocTest/en.expected/index.xml,
438 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
439 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
440 DocTest/en.expected.importslashdoc/index.xml,
441 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
442 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
443 DocTest/en.expected.since/index.xml,
444 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.xml,
445 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
446 DocTest/html.expected/index.html,
447 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1+FooEventArgs.html,
448 DocTest/html.expected/Mono.DocTest.Generic/index.html,
449 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html: Flush.
451 2008-03-31 Jonathan Pryor <jpryor@novell.com>
453 * DocTest-v1.cs: Add a member returning an IEnumerator<int[]> to test n375291.
454 * DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
455 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
456 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
457 DocTest/html.expected/Mono.DocTest/Widget.html,
458 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html: Flush.
460 2008-03-26 Jonathan Pryor <jpryor@novell.com>
462 * DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Flush due to
463 ../engine/mdoc-html-utils.xsl changes with migration of explicitly
464 implemented interface members to a separate section.
466 2008-03-26 Jonathan Pryor <jpryor@novell.com>
468 * DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
469 DocTest/html.expected/Mono.DocTest/UseLists.html: Flush due to
470 ../engine/mdoc-html-utils.xsl changes with s/System.Collections.Generic//.
473 2008-03-26 Jonathan Pryor <jpryor@novell.com>
475 * Makefile.am: Import docs for System.Action<T>.
476 * DocTest-v1.cs: Add System.Action<T> to test generic type importing.
477 * monodocer.cs: Misc. fixes:
478 - Properly lookup generic types when importing ECMA docs, so that e.g.
479 System.Collections.Generic.List<T> docs can be imported.
480 - Fix member duplicate checking so that we don't get an exception due to
481 seenmembers.Add(sig, "") for duplicate sigs.
482 - Fix UpdateParameters() to handle updating <param/> nodes on delegates.
483 * TestEcmaDocs.xml: Add docs for System.Action<T>.
484 * DocTest/en.expected/index.xml, DocTest/en.expected/System/Action`1.xml,
485 DocTest/en.expected.importecmadoc/System/Action`1.xml,
486 DocTest/en.expected.importslashdoc/index.xml,
487 DocTest/en.expected.importslashdoc/System/Action`1.xml,
488 DocTest/en.expected.since/index.xml,
489 DocTest/en.expected.since/System/Action`1.xml,
490 DocTest/html.expected/index.html, DocTest/html.expected/System/index.html,
491 DocTest/html.expected/System/Action`1.html: Flush.
493 2008-03-25 Jonathan Pryor <jpryor@novell.com>
495 * stylesheet.xsl: Implement CreateEditLink() for mdoc-html-utils.xsl.
497 2008-03-24 Jonathan Pryor <jpryor@novell.com>
499 * stylesheet.xsl: Implement CreateExpandedToggle() for
500 mdoc-sections-css.xsl.
502 2008-03-24 Jonathan Pryor <jpryor@novell.com>
504 * DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Flush due to
505 changes in ID string generation in ../engine/mdoc-html-utils.xsl.
507 2008-03-17 Jonathan Pryor <jpryor@novell.com>
509 * monodocer.cs: Modify index.xml so that there's a //Type/@Kind attribute.
510 This allows mkestner's doc engine to display the tree view (e.g. "Foo
511 Class") w/o loading the underlying Foo.xml file, improving start time.
512 * DocTest/en.expected/index.xml, DocTest/en.expected.since/index.xml,
513 DocTest/en.expected.importslashdoc/index.xml: Flush.
515 2008-03-15 Jonathan Pryor <jpryor@novell.com>
517 * monodocs2html.cs: Fix DumpTemplate() -- sending the output through an
518 intermediate XmlDocument seems to "corrupt" the file, such that any user
519 of the dumped file will get errors such as "Could not resolve named
520 template create-default-style."
522 2008-03-15 Jonathan Pryor <jpryor@novell.com>
524 * defaulttemplate.xsl: Cleanup (add/remove CSS properties, etc.).
525 * Makefile.am: monodocs2html needs to pull in resources from ../engine.
526 * monodocs2html.cs: Use ManifestResourceResolver so that .xsl files embedded
527 within the monodocs2html.exe assembly can refer to each other; use
528 XhtmlWriter so that certain XHTML elements are "closed", e.g. <br/>
529 instead of <br></br>.
530 * XhtmlWriter.cs: Added; XmlWriter subclass which generates nicer XHTML.
531 * stylesheet.xsl: *Major* refactor to share XSLT code with ../engine.
532 * DocTest/html.expected/index.html, DocTest/html.expected/NoNamespace.html,
533 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
534 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
535 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
536 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
537 DocTest/html.expected/Mono.DocTest.Generic/index.html,
538 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
539 DocTest/html.expected/Mono.DocTest/Color.html,
540 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
541 DocTest/html.expected/Mono.DocTest/Widget.html,
542 DocTest/html.expected/Mono.DocTest/Widget+Del.html,
543 DocTest/html.expected/Mono.DocTest/DocValueType.html,
544 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
545 DocTest/html.expected/Mono.DocTest/IProcess.html,
546 DocTest/html.expected/Mono.DocTest/index.html,
547 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
548 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
549 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
550 DocTest/html.expected/Mono.DocTest/UseLists.html,
551 DocTest/html.expected/System/Environment+SpecialFolder.html,
552 DocTest/html.expected/System/Array.html,
553 DocTest/html.expected/System/Environment.html,
554 DocTest/html.expected/System/index.html,
555 DocTest/html.expected/System/AsyncCallback.html: Flush.
557 2008-03-07 Jonathan Pryor <jpryor@novell.com>
559 * mdoc.cs: Rename export-slashdoc command to export-msxdoc. Add a space
560 between the `usage:' and command description to ease reading.
562 2008-03-07 Jonathan Pryor <jpryor@novell.com>
564 * monodocs2slashdoc.cs: Update to cope with .NET 2.0 generics.
565 * DocTest-v1.cs: Fix CREF comments.
566 * DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
567 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
568 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
569 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html: Flush
570 due to above CREF changes.
572 2008-03-06 Joshua Tauberer <jit@occams.info>
574 * monodocer.cs: Use Path.Combine in a few places.
576 2008-03-03 Jonathan Pryor <jpryor@novell.com>
578 * Makefile.am: Test the new -import: monodocer option.
579 * mdoc.cs: Make --import take only one parameter, the file to import.
580 * monodocer.cs: Add a new -import option which auto-detects the XML format
581 so that mdoc (and the user) doesn't need to care about file formats.
582 * Options.cs: Flush (fixes "<>" error when parsing 2-value "i|import").
584 2008-02-29 Jonathan Pryor <jpryor@novell.com>
586 * Makefile.am: Use mcs1 to build monodocer1.exe (as mcs now targets the 2.0
589 2008-02-29 Jonathan Pryor <jpryor@novell.com>
591 * Makefile.am: Corrections to pass distcheck.
593 2008-02-27 Jonathan Pryor <jpryor@novell.com>
595 * mdoc.cs: `mdoc assemble` should default to the "ecma" format, as that's
596 what most of the other mdoc tools produce & consume.
598 2008-02-26 Jonathan Pryor <jpryor@novell.com>
600 * mdoc.cs: Allow multiple formats to be specified on the `mdoc assemble`
601 command line; directories use the last specified format. This allows more
602 than one format to be specified at once, e.g.
603 `mdoc assemble -o foo --format=ecma A B --format=error C D`.
604 * Options.cs: Update to permit the above "argument run" parsing behavior.
606 2008-02-24 Jonathan Pryor <jpryor@novell.com>
608 * mdoc.cs: Remove array index out of bound exception in ExportHtml; remove
610 * defaulttemplate.xsl: s/<tab>/ /; add create-default-collection-title,
611 create-default-title, create-default-summary, create-default-signature,
612 create-default-remarks, create-default-members named templates (for use by
613 importing XSLT files).
614 * DocTest/html.expected/**/*.html: Flush (whitespace changes).
616 2008-02-21 Jonathan Pryor <jpryor@novell.com>
618 * Makefile.am: Add mdoc.exe to the build.
619 * monodocer.cs: Place into the Mono.Documentation namespace;
620 rename Stub to Updater.
621 * monodocs2slashdoc.cs: Place into the Mono.Documentation namespace; allow
622 it to convert multiple directories.
623 * mdoc.cs: Added; a unifying front-end to the various monodoc-related
624 utilities such as monodocer, monodocs2html, mdassembler, etc.
625 * Options.cs: An option parser; DO NOT EDIT; instead, see NDesk.Options at
626 http://www.ndesk.org/Options.
628 2008-02-19 Jonathan Pryor <jpryor@novell.com>
630 * defaulttemplate.xsl: Insert id attributes so that an "index" can be added;
631 Add a small "index" to the top of the page to simplify navigation --
632 useful when there are lots of docs that make the "Members" section
633 difficult to otherwise find. Add a http-equiv Content-Type, so that the
634 charset is set to UTF-8.
635 * stylesheet.xsl: Don't use generate-id(), as the result includes the full
636 path of the input file, which breaks unit tests if run on a different
637 machine (and everyone runs the unit tests, right?). Add id attributes so
638 that defaulttemplate.xsl can create an index.
639 * DocTest/html.expected/System/Environment+SpecialFolder.html,
640 DocTest/html.expected/System/Array.html,
641 DocTest/html.expected/System/Environment.html,
642 DocTest/html.expected/System/index.html,
643 DocTest/html.expected/System/AsyncCallback.html,
644 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
645 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
646 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
647 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
648 DocTest/html.expected/Mono.DocTest.Generic/index.html,
649 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
650 DocTest/html.expected/index.html,
651 DocTest/html.expected/Mono.DocTest/Color.html,
652 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
653 DocTest/html.expected/Mono.DocTest/Widget.html,
654 DocTest/html.expected/Mono.DocTest/Widget+Del.html,
655 DocTest/html.expected/Mono.DocTest/DocValueType.html,
656 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
657 DocTest/html.expected/Mono.DocTest/IProcess.html,
658 DocTest/html.expected/Mono.DocTest/index.html,
659 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
660 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
661 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
662 DocTest/html.expected/Mono.DocTest/UseLists.html,
663 DocTest/html.expected/NoNamespace.html: Flush.
665 2008-02-15 Jonathan Pryor <jpryor@novell.com>
667 * defaulttemplate.xsl: Move the <style/> and (new) <script/> into named
668 templates so that this file can be <xsl:import/>d and the named templates
669 invoked without clobbering the importing document; add toggle_display()
670 JavaScript function for some bling. Modify CSS so things look nicer.
671 * stylesheet.xsl: Make monodocs2html output not suck (as badly):
672 - Allow *all* headers to also act as show/hide toggles, so that e.g.
673 Remarks, Examples, Parameters, etc. can be hidden.
674 - Move the summary information above the member prototype (consistent
675 with MSDN, and I think it looks nicer).
676 - Provide an `id' attribute for enumeration members, so that
677 <see cref="F:..." /> will work reasonably.
678 - Allow the <pre/> blocks to use the `prettyprint.js' file (used by
679 monologue for syntax coloring) -- requires setting the <pre/> class to
680 e.g. code-csharp for C# coloring.
681 * DocTest/html.expected/System/Environment+SpecialFolder.html,
682 DocTest/html.expected/System/Array.html,
683 DocTest/html.expected/System/Environment.html,
684 DocTest/html.expected/System/index.html,
685 DocTest/html.expected/System/AsyncCallback.html,
686 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
687 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
688 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
689 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
690 DocTest/html.expected/Mono.DocTest.Generic/index.html,
691 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
692 DocTest/html.expected/index.html,
693 DocTest/html.expected/Mono.DocTest/Color.html,
694 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
695 DocTest/html.expected/Mono.DocTest/Widget.html,
696 DocTest/html.expected/Mono.DocTest/Widget+Del.html,
697 DocTest/html.expected/Mono.DocTest/DocValueType.html,
698 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
699 DocTest/html.expected/Mono.DocTest/IProcess.html,
700 DocTest/html.expected/Mono.DocTest/index.html,
701 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
702 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
703 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
704 DocTest/html.expected/Mono.DocTest/UseLists.html,
705 DocTest/html.expected/NoNamespace.html: Flush (lots of HTML changes due to
706 defaulttemplate.xsl and stylesheet.xsl changes).
708 2008-02-14 Jonathan Pryor <jpryor@novell.com>
710 * stylesheet.xsl: Support <typeparamref/>.
712 2008-02-13 Jonathan Pryor <jpryor@novell.com>
714 * DocTest-v1.cs: Add/fix doc comments; add a
715 Widget(Converter<string,string>) constructor for testing.
716 * stylesheet.xsl: Fix display issues:
717 - Generic types should have GetTypeDisplayName() on their constituent
718 parts, so System.Converter<System.String,System.String>
719 gets converted into the nicer Converter<string, string>.
720 - Generic types within method argument lists should be supported.
721 - Permit constructor references to contain arguments, so that
722 "C:My.Full.Type(Type1,Type2)" actually works.
723 - Fix remote type references so
724 <see cref="M:System.Collections.Generic.List{System.Int32}.Remove(`0)"/>
725 properly reference the remote uri
726 System.Collections.Generic.List`1.Remove(`0).
727 * DocTest/en.expected/Mono.DocTest/Widget.xml,
728 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
729 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
730 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
731 DocTest/html.expected/System/Array.html,
732 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
733 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
734 DocTest/html.expected/Mono.DocTest/Widget.html,
735 DocTest/html.expected/Mono.DocTest/UseLists.html: Flush.
737 2008-02-08 Jonathan Pryor <jpryor@novell.com>
739 * stylesheet.xsl: Allow use of both <see cref="GenericType{A}" /> and
740 <see cref="GenericType<A>" /> to be consistent wrt each other.
741 - Canonicalize generic types within link targets so that {} is used, as
742 1. this is what the */@id code generates, so such links will actually
743 work (as opposed to <>-using links, which will fail), and
744 2. the {} links are shorter and easier to read due to less markup.
745 - Canonicalize generic types within link text to use <>, so e.g.
746 <see cref="System.Action{`0}" /> is displayed as System.Action<`0>.
747 This also allows output to be consistent, no matter what the see/@cref
749 - When creating links to go-mono.com, ensure that generic type names are
750 of the form Type`N, not Type{...}, as go-mono.com doesn't generate
751 useful output for the latter form of URL.
752 * DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Flush.
754 2008-01-06 Jonathan Pryor <jpryor@novell.com>
756 * monodocer.cs: Yet another "if you remove a node while traversing its
757 containing list, you skip elements" bug (in this case, if you had extra
758 <param/> elements for non-existant parameters, only the first extra
759 <param/> was removed, and the others were skipped). Modify the messge
760 displayed for undeletable <param/> nodes to provide more contextual
763 2008-01-05 Jonathan Pryor <jpryor@novell.com>
766 - Fix duplicate and removed member checking/handling, so that duplicate
767 and removed members are properly warned about/removed (depending
768 on MemberDocsHaveUserContent()).
769 - Member sorting should take the return type into consideration, as I've
770 seen some ../class/** members which change the return type between
771 v1.0 and v2.0, causing the order of these members to "float" (as they
772 previously had the same sort order).
774 2008-01-03 Jonathan Pryor <jpryor@novell.com>
776 * monodocer.cs: XmlNodeList doesn't appear to support removing nodes while
777 you're traversing the list. (It doesn't complain, but it doesn't iterate
778 over all the nodes either if you do so.) Don't do that.
780 2008-01-02 Jonathan Pryor <jpryor@novell.com>
782 * monodocer.cs: Don't generate files that contain characters that are
783 invalid on Win32 platforms. These are frequently compiler-generated
784 types, e.g. '<>c__CompilerGenerated2+<>c__CompilerGenerated13', but are
785 occasionally public when they shouldn't be. Fix the
786 UpdateAssemblyVersions() logic to return true IFF there are > 0
787 <AssemblyVersion/> elements.
789 2008-01-02 Jonathan Pryor <jpryor@novell.com>
791 * DocTest-v1.cs: Add a type to the root namespace.
792 * monodocer.cs: Permit types to exist in the root namespace. This is needed
793 to properly document ../class/Npgsql, though I have no idea how `monodoc'
794 will actually display these types...
795 * overview.xsl: Support types within the root namespace.
796 * DocTest/en.expected/index.xml, DocTest/en.expected.since/index.xml,
797 DocTest/en.expected.importslashdoc/index.xml,
798 DocTest/html.expected/System/index.html,
799 DocTest/html.expected/Mono.DocTest.Generic/index.html,
800 DocTest/html.expected/index.html,
801 DocTest/html.expected/Mono.DocTest/index.html: Flush.
802 * DocTest/en.expected/NoNamespace.xml,
803 DocTest/en.expected/ns-.xml,
804 DocTest/en.expected.importslashdoc/NoNamespace.xml,
805 DocTest/en.expected.importslashdoc/ns-.xml,
806 DocTest/en.expected.since/NoNamespace.xml,
807 DocTest/en.expected.since/ns-.xml,
808 DocTest/html.expected/NoNamespace.html: Added.
810 2008-01-02 Jonathan Pryor <jpryor@novell.com>
813 - Write namespace files as 'ns-<Namespace>.xml', not '<Namespace>.xml', as
814 the previous behavior would break monodoc checkout on Win32 (due to dir
815 class/System.Security/en/System.Security.Cryptography.Xml vs. file
816 class/System.Security/en/System.Security.Cryptography.xml).
817 - This will rename existing <Namespace>.xml to ns-<Namespace>.xml
819 - gmcs/mcs changed Reflection names (again); cope.
820 * DocTest/en.expected/System.xml,
821 DocTest/en.expected/Mono.DocTest.Generic.xml,
822 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
823 DocTest/en.expected/Mono.DocTest.xml, DocTest/en.expected.since/System.xml,
824 DocTest/en.expected.since/Mono.DocTest.Generic.xml,
825 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
826 DocTest/en.expected.since/Mono.DocTest.xml,
827 DocTest/en.expected.importslashdoc/System.xml,
828 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic.xml,
829 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
830 DocTest/en.expected.importslashdoc/Mono.DocTest.xml: Rename to have a
832 * Makefile.am: Remove obsolete targets; add -show_exceptions to tests so we
833 get more information on errors.
834 * overview.xsl: Use the 'ns-' prefixed namespace documentation files.
836 2007-12-19 Jonathan Pryor <jpryor@novell.com>
838 * monodocer.cs: PropertyInfo.GetValue() may throw (in particular, within
839 System.Data when trying to read ToolboxItemAttribute which references an
840 assembly not present within the GAC). Workaround this.
842 2007-12-19 Jonathan Pryor <jpryor@novell.com>
844 * monodocer.cs: Add a -show_exceptions argument to provide full stack traces
845 when an error occurs (helps with debugging). Allow VersionComparer to
846 work on "slightly" malformed Version strings like 1.0.x.x, which some
847 existing documentation uses.
849 2007-12-18 Jonathan Pryor <jpryor@novell.com>
851 * monodocer.cs: Don't append ';' to property declarations.
852 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
853 DocTest/en.expected/Mono.DocTest/Widget.xml,
854 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
855 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
856 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
857 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml: Flush.
859 2007-12-18 Jonathan Pryor <jpryor@novell.com>
861 * monodocer.cs: Insert [return:] custom attributes within <ReturnValue/>.
862 * DocTest-v1.cs: Add custom attributes to various members for testing.
863 * DocTest/en.expected/Mono.DocTest/Widget.xml,
864 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
865 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
866 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
867 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
868 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
869 DocTest/html.expected/Mono.DocTest/Widget.html,
870 DocTest/html.expected/Mono.DocTest/DocAttribute.html: Flush.
872 2007-12-17 Jonathan Pryor <jpryor@novell.com>
874 * monodocer.cs: Document protected events.
875 * DocTest-v1.cs: Change the visibility of various members so we can better
876 test the monodocs2html output.
877 * stylesheet.xsl: Fix the `protected' check so that public members aren't
878 displayed under the Protected [MemberType] section.
879 * DocTest/en.expected/Mono.DocTest/Widget.xml,
880 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
881 DocTest/html.expected/Mono.DocTest/Widget.html,
882 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml: Flush.
884 2007-12-13 Jonathan Pryor <jonpryor@vt.edu>
886 * monodocer.cs: Er, *really* sort the <AssemblyVersion/> entries.
888 2007-12-12 Jonathan Pryor <jonpryor@vt.edu>
890 * monodocer.cs: Sort the <AssemblyVersion/> entries so that when rendering
891 them within monodoc we show versions in increasing order.
893 2007-12-11 Jonathan Pryor <jonpryor@vt.edu>
895 * monodocer.cs: Don't use File.OpenWrite(), as that doesn't truncate the
896 file (resulting in invalid XML errors if the new file is smaller than the
897 previous file). Add a local OpenWrite() to ensure that UTF8 is used
900 2007-12-11 Jonathan Pryor <jonpryor@vt.edu>
902 * monodocer.cs: Generate a per-member <AssemblyInfo/> element, not an
903 <AssemblyVersions/> element. This makes it easeier to write the XSLT
904 used in the docbrowser to generate the Requirements section.
905 * stylesheet.xsl: Use <AssemblyInfo/>, not <AssemblyVersions/>.
906 * DocTest/en.expected/System/Environment.xml,
907 DocTest/en.expected/System/AsyncCallback.xml,
908 DocTest/en.expected/System/Environment+SpecialFolder.xml,
909 DocTest/en.expected/System/Array.xml,
910 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
911 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
912 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
913 DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
914 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
915 DocTest/en.expected/Mono.DocTest/Widget.xml,
916 DocTest/en.expected/Mono.DocTest/Widget+Del.xml,
917 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
918 DocTest/en.expected/Mono.DocTest/IProcess.xml,
919 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
920 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
921 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
922 DocTest/en.expected/Mono.DocTest/UseLists.xml,
923 DocTest/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
924 DocTest/en.expected/Mono.DocTest/Color.xml,
925 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
926 DocTest/en.expected.since/System/Environment.xml,
927 DocTest/en.expected.since/System/AsyncCallback.xml,
928 DocTest/en.expected.since/System/Environment+SpecialFolder.xml,
929 DocTest/en.expected.since/System/Array.xml,
930 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
931 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
932 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
933 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
934 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
935 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
936 DocTest/en.expected.since/Mono.DocTest/AddedType.xml,
937 DocTest/en.expected.since/Mono.DocTest/Widget+Del.xml,
938 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
939 DocTest/en.expected.since/Mono.DocTest/IProcess.xml,
940 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
941 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
942 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
943 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
944 DocTest/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
945 DocTest/en.expected.since/Mono.DocTest/Color.xml,
946 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
947 DocTest/en.expected.importecmadoc/System/Environment.xml,
948 DocTest/en.expected.importecmadoc/System/AsyncCallback.xml,
949 DocTest/en.expected.importecmadoc/System/Array.xml,
950 DocTest/en.expected.importslashdoc/System/Environment.xml,
951 DocTest/en.expected.importslashdoc/System/AsyncCallback.xml,
952 DocTest/en.expected.importslashdoc/System/Environment+SpecialFolder.xml,
953 DocTest/en.expected.importslashdoc/System/Array.xml,
954 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
955 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
956 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
957 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
958 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
959 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
960 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
961 DocTest/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
962 DocTest/en.expected.importslashdoc/Mono.DocTest/IProcess.xml,
963 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass.xml,
964 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
965 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
966 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
967 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
968 DocTest/en.expected.importslashdoc/Mono.DocTest/Color.xml,
969 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml:
970 Flush; s/AssemblyVersion/AssemblyInfo/g.
972 2007-12-10 Jonathan Pryor <jonpryor@vt.edu>
974 * DocTest-v2.patch: Remove some members so that we can see some
975 <AssemblyVersions/> differences in the XML output.
976 * monodocer.cs: Add a <AssemblyVersions/> element under every type and member
977 to better track versioning information. The XML documentation now becomes
978 a "version database" of sorts, in which each member lists which assembly
979 versions it exists in. This permits tracking which members were added or
980 removed over time with greater fidelity than <since/>. This also removes
981 the need for -ignore_extra_docs, which is maintained (for compatibility)
983 * DocTest-v1.cs: Have differing visibility on a property to ensure it works
985 * stylesheet.xsl: Print out the per-member <AssemblyVersions/> element.
986 * DocTest/en.expected/System/Environment.xml,
987 DocTest/en.expected/System/AsyncCallback.xml,
988 DocTest/en.expected/System/Environment+SpecialFolder.xml,
989 DocTest/en.expected/System/Array.xml,
990 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
991 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
992 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
993 DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
994 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
995 DocTest/en.expected/Mono.DocTest/Widget.xml,
996 DocTest/en.expected/Mono.DocTest/Widget+Del.xml,
997 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
998 DocTest/en.expected/Mono.DocTest/IProcess.xml,
999 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
1000 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
1001 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
1002 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1003 DocTest/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
1004 DocTest/en.expected/Mono.DocTest/Color.xml,
1005 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
1006 DocTest/en.expected.since/System/Environment.xml,
1007 DocTest/en.expected.since/System/AsyncCallback.xml,
1008 DocTest/en.expected.since/System/Environment+SpecialFolder.xml,
1009 DocTest/en.expected.since/System/Array.xml,
1010 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
1011 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1012 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1013 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
1014 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1015 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1016 DocTest/en.expected.since/Mono.DocTest/AddedType.xml,
1017 DocTest/en.expected.since/Mono.DocTest/Widget+Del.xml,
1018 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
1019 DocTest/en.expected.since/Mono.DocTest/IProcess.xml,
1020 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
1021 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
1022 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
1023 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1024 DocTest/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
1025 DocTest/en.expected.since/Mono.DocTest/Color.xml,
1026 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
1027 DocTest/html.expected/System/Array.html,
1028 DocTest/html.expected/System/Environment.html,
1029 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
1030 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1031 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1032 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1033 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1034 DocTest/html.expected/Mono.DocTest/Widget.html,
1035 DocTest/html.expected/Mono.DocTest/DocValueType.html,
1036 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
1037 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
1038 DocTest/html.expected/Mono.DocTest/DocAttribute.html,
1039 DocTest/html.expected/Mono.DocTest/UseLists.html,
1040 DocTest/en.expected.importecmadoc/System/Environment.xml,
1041 DocTest/en.expected.importecmadoc/System/AsyncCallback.xml,
1042 DocTest/en.expected.importecmadoc/System/Array.xml,
1043 DocTest/en.expected.importslashdoc/System/Environment.xml,
1044 DocTest/en.expected.importslashdoc/System/AsyncCallback.xml,
1045 DocTest/en.expected.importslashdoc/System/Environment+SpecialFolder.xml,
1046 DocTest/en.expected.importslashdoc/System/Array.xml,
1047 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
1048 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1049 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1050 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1051 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1052 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
1053 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
1054 DocTest/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
1055 DocTest/en.expected.importslashdoc/Mono.DocTest/IProcess.xml,
1056 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass.xml,
1057 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
1058 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
1059 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1060 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
1061 DocTest/en.expected.importslashdoc/Mono.DocTest/Color.xml,
1062 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml:
1063 Flush, inserting <AssemblyVersion/> elements as necessary.
1065 2007-10-28 Jonathan Pryor <jonpryor@vt.edu>
1067 * DocTest-v1.cs: Correct doc comment.
1068 * DocTest/html.expected/System/Environment.html,
1069 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html,
1070 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1071 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1072 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1073 DocTest/html.expected/Mono.DocTest/UseLists.html,
1074 DocTest/en.expected.importslashdoc/System/Environment.xml,
1075 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
1076 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1077 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1078 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1079 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml: mcs and gmcs
1080 got many bug fixes with /doc support, changing many things that depend on
1083 2007-09-27 Raja R Harinath <rharinath@novell.com>
1085 * Makefile.am (DocTest.dll-v1, DocTest.dll-v2): Pick source from $srcdir.
1087 2007-07-19 Jonathan Pryor <jonpryor@vt.edu>
1089 * monodocer.cs: Always fully consume <Docs/> children. If we have e.g.
1090 <Docs><param name="foo"><see cref="T:Bar"/></param></Docs>, but there is
1091 no existing parameter "foo", we would previously process the nested
1092 <see/> node and append it to the <Docs/> child nodes.
1094 2007-07-18 Jonathan Pryor <jonpryor@vt.edu>
1096 * monodocer.cs: Change OrderDocsNodes() so that it uses
1097 XmlNode.InsertAfter() instead of XmlNode.InsertBefore(). The result is
1098 mostly the same (i.e. no regression test changes), but if you have a
1099 non-ordered node between other nodes this will force the non-ordered node
1100 to the *end* of the <Docs/> children, not the start. For example, given
1101 the input <Docs><summary/><exception/><remarks/></Docs/>, we used to get
1102 <Docs><exception/><summary/><remarks/></Docs>, while we now get
1103 <Docs><summary/><remarks/><exception/></Docs>.
1105 2007-07-17 Jonathan Pryor <jonpryor@vt.edu>
1107 * monodocer.cs: Insert the type's <Docs/> node before <Members/>. This is
1108 consistent with ECMA documentation ordering, and makes more sense (when
1109 editing the file you can edit the Type documentation before member
1110 documentation, instead of after all members as was the case before).
1111 * DocTest/en.expected/System/Environment.xml,
1112 DocTest/en.expected/System/Environment+SpecialFolder.xml,
1113 DocTest/en.expected/System/Array.xml,
1114 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
1115 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1116 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
1117 DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
1118 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1119 DocTest/en.expected/Mono.DocTest/Widget.xml,
1120 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
1121 DocTest/en.expected/Mono.DocTest/IProcess.xml,
1122 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
1123 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
1124 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
1125 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1126 DocTest/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
1127 DocTest/en.expected/Mono.DocTest/Color.xml,
1128 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
1129 DocTest/en.expected.since/System/Environment.xml,
1130 DocTest/en.expected.since/System/Environment+SpecialFolder.xml,
1131 DocTest/en.expected.since/System/Array.xml,
1132 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
1133 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1134 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1135 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
1136 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1137 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1138 DocTest/en.expected.since/Mono.DocTest/AddedType.xml,
1139 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
1140 DocTest/en.expected.since/Mono.DocTest/IProcess.xml,
1141 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
1142 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
1143 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
1144 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1145 DocTest/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
1146 DocTest/en.expected.since/Mono.DocTest/Color.xml,
1147 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
1148 DocTest/en.expected.importecmadoc/System/Environment.xml,
1149 DocTest/en.expected.importecmadoc/System/Array.xml,
1150 DocTest/en.expected.importslashdoc/System/Environment.xml,
1151 DocTest/en.expected.importslashdoc/System/Environment+SpecialFolder.xml,
1152 DocTest/en.expected.importslashdoc/System/Array.xml,
1153 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
1154 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1155 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1156 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1157 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1158 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
1159 DocTest/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
1160 DocTest/en.expected.importslashdoc/Mono.DocTest/IProcess.xml,
1161 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass.xml,
1162 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
1163 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
1164 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1165 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
1166 DocTest/en.expected.importslashdoc/Mono.DocTest/Color.xml,
1167 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml:
1168 Update so that <Docs/> comes before <Members/>, not after.
1170 2007-07-14 Jonathan Pryor <jonpryor@vt.edu>
1172 * monodocer.cs: If a <Type/> had an empty <Members/> element, we'd start
1173 reading the <Member/> elements from the *next* <Type/>; oops.
1174 * DocTest-v1.cs: Add System.AsyncCallback, which is a delegate and thus had
1175 an empty <Members/> element.
1176 * Makefile.am: Also import docs for System.AsyncCallback.
1177 * overview.xsl: Update $max-types so that adding System.AsyncCallback
1178 doesn't trigger the alternate behavior, creating a larger diff than
1180 * TestEcmaDocs.xml: Add docs for System.AsyncCallback.
1181 * DocTest/en.expected/System/AsyncCallback.xml,
1182 DocTest/en.expected/index.xml,
1183 DocTest/en.expected.since/System/AsyncCallback.xml
1184 DocTest/en.expected.since/index.xml,
1185 DocTest/html.expected/System/AsyncCallback.html
1186 DocTest/html.expected/System/index.html, DocTest/html.expected/index.html,
1187 DocTest/en.expected.importecmadoc/System/AsyncCallback.xml,
1188 DocTest/en.expected.importslashdoc/System/AsyncCallback.xml,
1189 DocTest/en.expected.importslashdoc/index.xml: Added; expected imported
1190 documentation for System.AsyncCallback.
1192 2007-07-14 Jonathan Pryor <jonpryor@vt.edu>
1194 * monodocer.cs: Remove the "While Importing ECMA <Docs/> chidren, found
1195 node..." error by ensuring that we're at the start of an actual
1196 non-whitespace element before hitting the switch statement.
1198 2007-07-14 Jonathan Pryor <jonpryor@vt.edu>
1200 * monodocer.cs: Don't call DoUpdateType() with non-public types. This
1201 allows `monodocer -importecmadoc` to fully run and import mscorlib.dll.
1203 2007-07-14 Jonathan Pryor <jonpryor@vt.edu>
1205 * monodocer.cs: Ensure that getting a MemberInfo based on the documentation
1206 that the MemberInfo was actually found... (Allows a full mscorlib.dll
1207 import to run for > 15s before dying.)
1209 2007-07-04 Jonathan Pryor <jonpryor@vt.edu>
1211 * monodocer.cs: Use XmlReader instead of XPathDocument to process the ECMA
1212 documentation import. This cuts down a -type:System.Array import from
1213 ~10-12s to ~7-8s (not great, but better). "Fix" the ordering of <Docs/>
1214 child elements so that importing ECMA/slashdoc documentation doesn't
1215 change the normal ordering.
1216 * DocTest/en.expected.importecmadoc/System/Array.xml,
1217 DocTest/en.expected.importecmadoc/System/Environment.xml: Alter order of
1218 <Docs/> elements to match the normally generated order.
1220 2007-06-20 Jonathan Pryor <jonpryor@vt.edu>
1222 * monodocer.cs: Sort /Type/Members/Member elements so that the order is not
1223 dependent upon Reflection order.
1224 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1225 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1226 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1227 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1228 DocTest/en.expected.importecmadoc/System/Array.xml,
1229 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml:
1230 Flush (sort <Member/> elements).
1232 2007-06-19 Jonathan Pryor <jonpryor@vt.edu>
1234 * monodocer.cs: Sort <Namespace/> and <Type/> elements by their Name
1235 attribute. This helps keep diff's smaller, as the generated order won't
1236 be dependent upon Reflection order.
1237 * DocTest/en.expected/index.xml, DocTest/en.expected.since/index.xml,
1238 DocTest/en.expected.importslashdoc/index.xml: Flush (sort namespaces and
1239 types alphabetically).
1241 2007-06-19 Jonathan Pryor <jonpryor@vt.edu>
1243 * monodocer.cs: Cleanup Console output.
1244 - Use Console.Error for error messages, not status messages.
1245 - Error should be prefixed by "monodocer" (follows Unix conventions).
1246 - Don't print "Updating..." followed by "New Type..." for the same type.
1247 - Use __monodocer-seen__ sentinal for imported nodes so that we don't try
1248 to lookup the corresponding member later in GetDocumentationMembers().
1250 2007-06-19 Jonathan Pryor <jonpryor@vt.edu>
1252 * monodocer.cs: Lots 'o fixes/improvements.
1253 - Allow multiple -type parameters to be specified.
1254 - Remove type member enumeration from UpdateTypes() -- use DoUpdateType2().
1255 - Iterate over assembly types in Ecma Documentation order (so that we read
1256 the Ecma docs sequentially, not randomly).
1257 - Allow -type to *create* new documentation files.
1258 - Remove unused methods.
1259 * Makefile.am: Add check-monodocer-importecmadoc,
1260 check-monodocer-importecmadoc-update targets (unit tests for
1262 * TestEcmaDocs.xml: Added; ECMA Documentation input file for use with
1263 -importecmadoc tests.
1264 * DocTest-v1.cs: Add System.Array to help test -importecmadoc behavior.
1265 * DocTest/en.expected/index.xml, DocTest/en.expected.since/index.xml,
1266 DocTest/html.expected/System/index.html, DocTest/html.expected/index.html,
1267 DocTest/en.expected.importslashdoc/index.xml: Flush (add System.Array to
1269 * DocTest/en.expected/System/Array.xml,
1270 DocTest/en.expected.since/System/Array.xml,
1271 DocTest/html.expected/System/Array.html,
1272 DocTest/en.expected.importecmadoc/System/Environment.xml,
1273 DocTest/en.expected.importecmadoc/System/Array.xml,
1274 DocTest/en.expected.importslashdoc/System/Array.xml: Added; expected
1275 output for System.Array type for various tests.
1277 2007-06-18 Wade Berrier <wberrier@novell.com>
1279 * monodocer.cs: Move assembly information up top because having it at the bottom
1280 fails to compile with mcs from trunk.
1282 2007-06-14 Jonathan Pryor <jonpryor@vt.edu>
1284 * monodocer.cs: Use XPathDocument instead of XmlDocument to process the ECMA
1285 documentation import. This cuts down a -type:System.Array import from
1286 ~15-20s to ~10-12s (not great, bug better). Fix importing of <exception/>
1287 elements -- previously we would skip them if the mono docs lacked them.
1289 2007-06-12 Jonathan Pryor <jonpryor@vt.edu>
1291 * monodocer.cs: The previous fix was buggy -- if the type parameters were
1292 renamed (ConvertAll<T,U> in ECMA, ConvertAll<TInput,TOutput> in Mono),
1293 then the existing element wouldn't be found, but the MemberInfo would.
1294 Result: duplicate XML elements (BOTH ConvertAll<T,U> AND
1295 ConvertAll<TInput,TOutput>), one of which is wrong, which clearly isn't
1296 desirable. If the Mono XML element can't be found, try looking it up
1297 based on the MemberInfo found from the ECMA docs to avoid duplication.
1299 2007-06-11 Jonathan Pryor <jonpryor@vt.edu>
1301 * monodocer.cs: Add support for renaming of template parameters (useful
1302 because ECMA 335 refers to Array.ConvertAll<T,U> while Mono/.NET have
1303 Array.ConvertAll<TInput,TOutput>). Not terribly intelligent, but smart
1304 enough that all but two System.Array members can now be imported (a
1305 private constructor, and a member with an incorrectly documented parameter
1306 type, neither of which I plan on supporting). Cleanup some of the
1307 `#if NET_1_0` blocks by using `using' aliases -- alas, requires moving the
1308 [assembly:...] attributes; see bugzilla #81855.
1310 2007-06-11 Jonathan Pryor <jonpryor@vt.edu>
1312 * monodocer.cs: Add support for explicity-implemented interface members.
1313 Minor cleanup. Replace catch(NotSupportedException){} blocks.
1314 * Makefile.am (clean): Cleanup monodocer.exe* files.
1315 * DocTest-v1.cs: Add IFoo<T>, explicitly implement some interfaces on
1316 MyList<A,B> to test explicitly-implemented member support.
1317 * DocTest/en.expected/index.xml,
1318 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1319 DocTest/en.expected.since/index.xml,
1320 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1321 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1322 DocTest/html.expected/Mono.DocTest.Generic/index.html,
1323 DocTest/html.expected/index.html,
1324 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
1325 DocTest/en.expected.importslashdoc/index.xml,
1326 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1327 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml:
1329 * DocTest/en.expected/Mono.DocTest.Generic/IFoo`1.xml,
1330 DocTest/en.expected.since/Mono.DocTest.Generic/IFoo`1.xml,
1331 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/IFoo`1.xml,
1332 DocTest/html.expected/Mono.DocTest.Generic/IFoo`1.html: Added.
1334 2007-05-29 Jonathan Pryor <jonpryor@vt.edu>
1336 * monodocer.cs: Invert ECMA documentation importing -- instead of iterating
1337 over the monodoc XML and importing ECMA docs as encountered (randomly),
1338 iterate over the ECMA docs in-order and access the monodoc types randomly.
1339 This significantly improves access as the ECMA docs are ~7.2MB in size,
1340 while the monodoc XML types 10's-100's of KB (randomly accessing a 7.2 MB
1341 XML document == BAD; randomly accessing a several hundred KB document is
1342 better). This cuts down a -type:System.Array import from ~4 minutes to
1343 < ~20s. Alas, it appears to miss a few members as well, so it's not done.
1345 2007-05-19 Jonathan Pryor <jonpryor@vt.edu>
1347 * monodocer.cs: Create diff(1)-friendly output for -importecmadocs.
1348 Previously, we'd remove <summary/>, <remarks/>, etc., and re-add them at
1349 the end of the <Docs/> node, which results in major changes for diff(1),
1350 so instead we replace the contents of existing elements when appropriate.
1351 Remove '\r' from the imported document (also to remove diff(1)-reported
1352 changes as the line endings would change).
1354 2007-05-17 Jonathan Pryor <jonpryor@vt.edu>
1356 * monodocer.cs: Add -importecmadoc flag, which will import
1357 documentation found within an ECMA documetation file (e.g. the
1358 CLILibraryTypes.xml from the ECMA-335 standard).
1359 WARNING: import is currently SLOW.
1361 2007-05-17 Jonathan Pryor <jonpryor@vt.edu>
1363 * monodocer.cs: Refactor MakeDocNode() so that there's only one
1364 version, not three overloads, and use a (new) DocsNodeInfo type to
1365 pass information to the new MakeDocNode() method. This doesn't
1366 change anything per-se, but it'll make it easier to pass new
1367 parameters to MakeDocNode() without making the rediculously long
1368 parameter list even longer...
1370 2007-05-12 Joshua Tauberer <jit@occams.info>
1372 * overview.xsl: Always sort type names, since when updating
1373 docs monodocer can make the list in index.xml out of order.
1374 * monodocer.cs: When deleting duplicate member entries, delay
1375 deletion until after loop is finished.
1376 * Makefile.am, DocTest-v1.cs, DocTest/en.expected.importslashdoc,
1377 DocTest/html.expected: Revise monodocs2html tests to use
1378 the /doc file so we can test those tags too. And changed two
1379 <c> tags to <see cref=/>.
1380 * stylesheet.xsl, DocTest/html.expected: Fix see-links to methods,
1381 which didn't recognize '(' as delimiting type from args, and
1382 display nice type names for arguments.
1384 2007-03-15 Lluis Sanchez Gual <lluis@novell.com>
1386 * monodocer.cs: When deleting a member, don't remove it from the
1387 parent xml element until all members are checked, since doing
1389 Properly import internal protected members.
1391 2006-12-29 Jonathan Pryor <jonpryor@vt.edu>
1393 * Makefile.am: Add check-monodocer-ignore_extra_docs-update,
1394 check-doc-tools-update, and check-update targets.
1395 * monodocer.cs: Fix generation of attribute parameters, as e.g.
1396 `AttributeUsage.Class|Struct' doesn't look right; it should
1397 instead be `AttributeUsage.Class | AttributeUsage.Struct'.
1398 * DocTest-v1.cs: Add new public Attribute with an AttributeUsage for tests.
1399 * DocTest/en.expected/index.xml,
1400 DocTest/en.expected/Mono.DocTest/DocAttribute.xml,
1401 DocTest/en.expected.importslashdoc/index.xml,
1402 DocTest/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
1403 DocTest/en.expected.since/index.xml,
1404 DocTest/en.expected.since/Mono.DocTest/DocAttribute.xml,
1405 DocTest/html.expected/index.html,
1406 DocTest/html.expected/Mono.DocTest/index.html,
1407 DocTest/html.expected/Mono.DocTest/DocAttribute.html: Added; update
1408 expected output for new tests.
1410 2006-12-29 Jonathan Pryor <jonpryor@vt.edu>
1412 * monodocer.cs: Fix C# type name generation for nested types in the System
1413 namespace. Remove TypeCastException when dealing with custom attributes.
1414 * DocTest-v1.cs: Add System.Environment type for testing System handling.
1415 * DocTest/en.expected/index.xml, DocTest/en.expected/System.xml,
1416 DocTest/en.expected/System/Environment.xml,
1417 DocTest/en.expected/System/Environment+SpecialFolder.xml,
1418 DocTest/en.expected.since/index.xml, DocTest/en.expected.since/System.xml,
1419 DocTest/en.expected.since/System/Environment+SpecialFolder.xml,
1420 DocTest/en.expected.since/System/Environment.xml,
1421 DocTest/en.expected.importslashdoc/index.xml,
1422 DocTest/en.expected.importslashdoc/System.xml,
1423 DocTest/en.expected.importslashdoc/System/Environment.xml,
1424 DocTest/en.expected.importslashdoc/System/Environment+SpecialFolder.xml,
1425 DocTest/html.expected/index.html, DocTest/html.expected/System/index.html,
1426 DocTest/html.expected/System/Environment.html,
1427 DocTest/html.expected/System/Environment+SpecialFolder.html:
1428 Added; update expected output for new tests.
1430 2006-12-29 Jonathan Pryor <jonpryor@vt.edu>
1432 * monodocer.cs: `abstract sealed' classes are actually `static' classes.
1434 2006-12-27 Jonathan Pryor <jonpryor@vt.edu>
1436 * monodocer.cs: Re-order the attributes in <Type/> elements so that the
1437 ordering is (somewhat) well defined. This helps with `diff' output in
1438 ../class, as it prevents "false positives" when the attributes are
1439 re-ordered. Fix CSharpFullMemberFormatter.GetTypeDeclaration() so that
1440 when handling C# builtin types (e.g. System.Byte) it uses the real name in
1441 the declaration instead of the C# keyword (`class byte' is wrong).
1443 2006-12-26 Jonathan Pryor <jonpryor@vt.edu>
1445 * Makefile.am: Add check-monodocer-ignore_extra_docs test.
1446 * monodocer.cs: Fix -ignore_extra_docs. Previously, it would just ignore
1447 "missing" types, but it would still remove "missing" members.
1449 2006-12-26 Jonathan Pryor <jonpryor@vt.edu>
1451 * monodocer.cs: Don't insert internal attributes into the documentation.
1452 * DocTest-v1.cs: Add test for use of an internal attribute.
1454 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1456 * monodocer.cs: Don't include full namespace for System.* types. *Do*
1457 include the full namespace for nested System types, e.g.
1458 System.Collections.IEnumerable. This is what is currently in
1459 ../class/corlib/en, and making this change results in a smaller diff.
1460 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1461 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1462 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1463 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1464 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1465 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml:
1466 Update unit tests for above monodocer.cs change.
1468 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1470 * monodocer.cs: Don't include full namespace for System.* types. This is
1471 what ECMA-335 CLILibraryTypes.xml does for C# declarations -- no
1472 namespaces within e.g. inheritance lists or parameter lists for the System
1473 namespace and namespaces nested within System.
1474 Remove unnecessary console output.
1475 * DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1476 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1477 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1478 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1479 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1480 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml:
1481 Update unit tests for above monodocer.cs change.
1483 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1485 * monodocer.cs: Make sure that the types we document are *really* public.
1486 For some reason public nested types of internal types are returned by
1487 Assembly.GetTypes(), e.g. ``internal class A { public class B {} }''
1488 These types shouldn't be documented.
1489 * DocTest-v1.cs: Add test case for above.
1491 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1493 * monodocer.cs: Add -ignore_extra_docs flag; when set, it will not rename
1494 .xml files for types not found to .xml.remove. This is useful in ../class
1495 when we're processing assemblies multiple times for the 1.0 & 2.0
1496 profiles, as when processing the 1.0 profile we'll be "missing" the 2.0
1497 types, and we don't want those to be renamed.
1499 2006-12-21 Jonathan Pryor <jonpryor@vt.edu>
1501 * Makefile.am: Add a monodocer1.exe target, which is a version of monodocer
1502 which runs under the 1.0 runtime. This is necessary so that we can still
1503 generate/update docs for mscorlib.dll 1.0 (as only one mscorlib.dll can
1504 ever be loaded into a process).
1505 * monodocer.cs: Split out the .NET 2.0 functionality so that it can be built
1506 for both 1.0 and 2.0 runtimes. 1.0 support is controlled by the
1509 2006-12-20 Jonathan Pryor <jonpryor@vt.edu>
1511 * monodocer.cs: Don't try too hard in UpdateParameters(). Previously, if a
1512 the number of parameters a method accepted changed from > 1 to 1, the
1513 "easy" <param/> handling would (inadvertently?) change all <param/>s to have
1514 the @name of the method's single parameter -- so if you _had_ parameters
1515 A, B, and C but the method now only has D, then A, B, and C would all have
1516 their @name attribute changed to D. Odd, but possibly acceptable...
1517 ...until we try to make sure that the <param/>s are in the right order, in
1518 which case we'll record the index of D as 0 (it's the 1st parameter), but
1519 find a parameter with a different index (the old B & C), causing us to
1520 reinsert the parameter to make sure it's in the proper order. This
1521 results in an infinite loop within System.Xml -- see Bugzilla #80331.
1522 It's safer to just ignore the extra parameters.
1524 2006-12-07 Jonathan Pryor <jonpryor@vt.edu>
1526 * DocTest-v1.patch: Add an operator returning a generic parameter (triggers
1527 error fixed in monodocer.cs).
1528 * DocTest-v2.patch: Update (due to changes in DocTest-v1.cs).
1529 * monodocer.cs: CSharpFullMemberFormatter.AppendVisibility() needs to accept null
1530 MethodBases (when called from GetEventDeclaration() and e.GetAddMethod()
1531 returns null); fix SlashDocMemberFormatter.GetMethodDeclaration() so that
1532 generic types can be the return value of methods. These changes allow
1533 generation of documentation on Mono's 2.0 mscorlib.dll.
1534 * stylesheet.xsl: Use GetParameterType() to emit the return type of
1535 explicit/implicit operators, as they can be/use generic arguments.
1536 * DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
1537 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1538 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
1539 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1540 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html:
1541 Flush to match current output.
1543 2006-11-22 Jonathan Pryor <jonpryor@vt.edu>
1545 * monodocer.cs: Don't generate documentation/prototypes for non-public
1546 property get/set accessors. Patch from Ivan N. Zlatev.
1548 2006-11-01 Jonathan Pryor <jonpryor@vt.edu>
1550 * monodocer.cs: When importing -importslashdoc documentation, convert
1551 <seealso/> elements into <altmember/> elements (as the former is the
1552 recommended element within ECMA-334, while the latter is the actual
1553 element used for our ECMA documentation).
1554 * DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml: Flush.
1556 2006-10-27 Jonathan Pryor <jonpryor@vt.edu>
1558 * stylesheet.xsl: Generate more correct string id's for "id" attribute
1559 values, so that string ids match the output of CSC.EXE 2.0. Changes:
1560 append ``N instead of `N for generic methods, and use the correct 0-based
1561 type parameter index, not a 1-based index.
1562 * DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1563 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1564 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1565 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1566 DocTest/html.expected/Mono.DocTest/UseLists.html: Flush.
1568 2006-10-24 Jonathan Pryor <jonpryor@vt.edu>
1570 * DocTest-v1.cs: Add /doc comments (for use with `make
1571 check-monodocer-importslashdoc`).
1572 * DocTest-v2.patch: Update (due to changes in DocTest-v1.cs).
1573 * Makefile.am: Add check-monodocer-importslashdoc,
1574 check-monodocer-importslashdoc-update targets.
1575 * monodocer.cs: Fix -importslashdoc. Massively refactor generation of
1576 strings from MemberInfos (Type, MethodInfo, etc.) so that commonalities
1577 between DocType, C#, and /doc string IDs can be shared and easily
1578 customized (as opposed to dealing with the > 100 line FillDocTypeName()
1579 method, which was already too complex).
1580 * DocTest/en.expected.importslashdoc/index.xml,
1581 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic.xml,
1582 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1.xml,
1583 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`2.xml,
1584 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
1585 DocTest/en.expected.importslashdoc/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1586 DocTest/en.expected.importslashdoc/Mono.DocTest.xml,
1587 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
1588 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Del.xml,
1589 DocTest/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
1590 DocTest/en.expected.importslashdoc/Mono.DocTest/IProcess.xml,
1591 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass.xml,
1592 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+NestedClass`1.xml,
1593 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+IMenuItem.xml,
1594 DocTest/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
1595 DocTest/en.expected.importslashdoc/Mono.DocTest/Color.xml,
1596 DocTest/en.expected.importslashdoc/Mono.DocTest/Widget+Direction.xml:
1597 Added; expected output for `make check-monodocer-importslashdoc'.
1599 2006-10-19 Jonathan Pryor <jonpryor@vt.edu>
1601 * Makefile.am: Change check-monodocer target to add a `monodocer -namespace'
1602 check, as `-namespace' would use a bad filename generation algorithm.
1603 * monodocer.cs: Don't use Type.Name (or equivalent) to generate filenames,
1604 but use GetTypeFileName(), so that Foo<T> only tries to open the file
1605 Foo`1, instead of the file Foo<T> which (1) is wrong, we never generate
1606 filenames like that, and (2) fails horribly on Win32 (as '<' and '>' are
1607 invalid path characters).
1609 2006-10-19 Jonathan Pryor <jonpryor@vt.edu>
1611 * monodocer.cs: Sort member ordering so that when the order of members
1612 returned by Type.GetMembers() changes (as it did between 1.1.17 and
1613 1.1.18) the order of the documentation members won't change (leading to
1614 "errors" in the regression tests).
1615 * DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
1616 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1617 DocTest/en.expected/Mono.DocTest/Widget.xml,
1618 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
1619 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
1620 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
1621 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1622 DocTest/en.expected/Mono.DocTest/Color.xml,
1623 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
1624 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
1625 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml,
1626 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1627 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
1628 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
1629 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
1630 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1631 DocTest/en.expected.since/Mono.DocTest/Color.xml,
1632 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
1633 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1634 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1635 DocTest/html.expected/Mono.DocTest/Color.html,
1636 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
1637 DocTest/html.expected/Mono.DocTest/Widget.html,
1638 DocTest/html.expected/Mono.DocTest/DocValueType.html,
1639 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
1640 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
1641 DocTest/html.expected/Mono.DocTest/UseLists.html: Flush. Since monodocer
1642 generates a different member ordering, *everything* gets a different
1645 2006-10-12 Jonathan Pryor <jonpryor@vt.edu>
1647 * monodocer.cs: Add support for inserting Docs/since element. This element
1648 is *only* inserted for NEW type/members, never updated, and is only
1649 inserted if the -since:SINCE command-line argument is provided.
1650 * DocTest.cs: Renamed to DocTest-v1.cs.
1651 * Makefile.am: Add DocTest.dll-v1, DocTest.dll-v2, check-monodocer-since,
1652 check-monodocer-since-update, check targets.
1653 * DocTest-v2.patch: Patch file applied to DocTest-v1.cs to get DocTest.dll
1655 * DocTest/en.expected.since/index.xml,
1656 DocTest/en.expected.since/Mono.DocTest.xml,
1657 DocTest/en.expected.since/Mono.DocTest/AddedType.xml,
1658 DocTest/en.expected.since/Mono.DocTest/Color.xml,
1659 DocTest/en.expected.since/Mono.DocTest/DocValueType.xml,
1660 DocTest/en.expected.since/Mono.DocTest/IProcess.xml,
1661 DocTest/en.expected.since/Mono.DocTest/UseLists.xml,
1662 DocTest/en.expected.since/Mono.DocTest/Widget.xml,
1663 DocTest/en.expected.since/Mono.DocTest/Widget+Del.xml,
1664 DocTest/en.expected.since/Mono.DocTest/Widget+Direction.xml,
1665 DocTest/en.expected.since/Mono.DocTest/Widget+IMenuItem.xml,
1666 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass.xml,
1667 DocTest/en.expected.since/Mono.DocTest/Widget+NestedClass`1.xml,
1668 DocTest/en.expected.since/Mono.DocTest.Generic.xml,
1669 DocTest/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
1670 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1.xml,
1671 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1672 DocTest/en.expected.since/Mono.DocTest.Generic/MyList`2.xml: Added;
1673 expected output for DocTest.dll v2.0.0.0.
1675 2006-10-11 Jonathan Pryor <jonpryor@vt.edu>
1677 * stylesheet.xsl: Add /Members/Docs node in GetInheritedMembers() so that
1678 GetLinkId() sees typeparam elements for type replacement in parameters for
1679 members of base types. Make sure that "simple" type arguments are
1680 replaced, e.g. T --> `1.
1681 TODO: figure out type replacements for nested types.
1682 * DocTest/html.expected/Mono.DocTest/UseLists.html,
1683 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1684 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1685 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1686 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html: Change link id's
1687 and targets for proper type replacements within parameters.
1689 2006-10-10 Joshua Tauberer <jit@occams.info>
1691 * monodocer.cs: Fixed a bug in WriteElement that would put
1692 nodes in the wrong place if some node in the path already
1694 - To prevent TypeParameters from always being put at the
1695 end on an update, don't delete that node in an update, just
1697 - Update the DisplayName attribute in index.xml on doc updates.
1698 * DocTest/*: Updated for the DisplayName fix, and also put
1699 into a pristine state (I had committed them as an update,
1700 which put the TypeParameters block at the end of the files.)
1702 2006-10-09 Joshua Tauberer <jit@occams.info>
1704 * monodocer.cs: Update a type's name attributes during an update
1705 because generic argument names may change even if filename
1707 - Added a Type/TypeParameters section which includes type
1708 parameters that come from the declaring type, for nested types.
1709 - When inheriting from a generic type, added a BaseTypeArguments
1710 section which maps type parameters on the base type's type
1711 definition to types instantiating those parameters. i.e.:
1713 class Y<U> : X<U> { }
1714 Y gets a mapping in its BaseType node from T to U.
1715 * stylesheet.xsl: Don't attempt to link to a generic type
1716 parameter, just display it in italics. And when displaying
1717 inherited members, try to replace generic type parameters
1718 in the base type with the types that have instantiated them
1720 * The DocTests are updated to show off these things.
1722 2006-10-08 Joshua Tauberer <jit@occams.info>
1724 * monodocer.cs: Track which members have been seen in the XML file
1725 not by putting MemberInfos into a hashtable, which seems to
1726 not always work right, but instead by their (string) signature.
1727 - Get custom attribute data with the new 2.0 CustomAttributeData
1728 classes, so that we can reconstruct what the constructor actually
1730 - Hide System.Runtime.InteropServices.Out attributes since it is
1731 fake and already in the RefType XML attribute.
1732 - Structs weren't getting their interfaces listed in their C# type
1734 * monodocs2html.cs: Don't override the default XSLT URI resolver anymore.
1735 * stylesheet.xsl: Get the index.xml document at the start while we're
1736 sure we have the right base path (the XML document being transformed).
1737 - Display inherited members in a type's member list when the base type
1738 is documented in the same monodocer document set.
1739 - Make sure there's a space between a method's parameters and return
1740 value type in the member list.
1741 * DocTest: Updated to test these things.
1743 2006-10-06 Jonathan Pryor <jonpryor@vt.edu>
1745 * overview.xsl: When generating a Namespace/index.html file, we should
1746 insert the namespace remarks as well. (This *should* have been done, but
1747 the remarks selection was relative to '.', not to the provided $ns. :-(
1748 * DocTest/html.expected/Mono.DocTest.Generic/index.html,
1749 DocTest/html.expected/Mono.DocTest/index.html: Flush.
1751 2006-10-06 Jonathan Pryor <jonpryor@vt.edu>
1753 * Makefile.am: Fix -update targets so they don't delete .svn/*.
1754 * monodocer.cs: Don't key off of DisplayName to insert new <Type> elements,
1755 as this will result in updating all existing documentation (rather silly).
1756 Key off of Name instead, and only create a DisplayName attribute if it
1758 * DocTest/en.expected/index.xml: Update to latest monodocer output.
1759 * monodocs2html.cs: If DisplayName doesn't exist, fall back to
1760 Name ("legacy" behavior, now made current due to change in monodocer.cs).
1761 * stylesheet.xsl: For "Name [Generic ] [MemberType]" descriptions, make the
1762 2nd space part of "Generic". Otherwise we get double spaces for
1763 non-generic members, e.g. "Name [MemberType]".
1764 * overview.xsl: Fallback to @Name if @DisplayName doesn't exist.
1765 * DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1766 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1767 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1768 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1769 DocTest/html.expected/Mono.DocTest/Widget.html,
1770 DocTest/html.expected/Mono.DocTest/DocValueType.html,
1771 DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
1772 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
1773 DocTest/html.expected/Mono.DocTest/UseLists.html: Update to latest
1774 monodocs2html output.
1776 2006-10-06 Jonathan Pryor <jonpryor@vt.edu>
1778 * Makefile.am: Build with gmcs; add `-debug' to compile lines; add
1779 DocTest.dll, check-monodocer, check-monodocer-update, check-monodocs2html/
1780 check-monodocs2html-update targets for unit tests.
1781 * monodocer.cs: Major overhaul for Generics support. Documentation
1782 generated follows the pattern used in CLILibraryTypes.xml from ECMA-335.
1783 - Remove some warnings about unused variables.
1784 - Don't assume that Type.FullName is always what we want, but instead
1785 build a C# typename from the Type information. This is needed to nicely
1786 deal with generics, as the FullName for Foo<int> would be
1787 Foo[[System.Int32, mscorlib]], while we really want Foo<int>.
1788 - For index.xml files, insert a File attribute, as the Type name won't
1789 match the filename for generic types (Foo<T> is the file Foo`1.xml).
1790 - For GetMember(), remove generic parameters before using Type.GetMember()
1791 with the member name.
1792 - Code refactoring so that <param/> and <typeparam/> generation & updating
1794 - Properly use `this' for method name on indexers.
1795 * monodocs2html.cs: Add Generics support -- use the @File attribute instead
1796 of assuming that @Name contains the proper filename.
1797 * defaulttemplate.xsl: Use <h1> instead of <div>; add CSS for
1798 `.InnerSignatureTable tr' and `.TypePermissionTable tr'.
1799 * overview.xsl: If there are fewer than $max-types (20) types in the
1800 assembly, show them all in the top-level index.html, no matter how many
1801 namespaces are present. Otherwise, provide links to the
1802 Namespace/index.html files, so that things don't suddenly look different
1803 as soon as you go from 1 namespace to > 1 namespaces in an assembly.
1804 Use <h2/> instead of <div/>.
1805 * stylesheet.xsl: Major overhaul for Generics support, some re-indentation.
1806 - Use <h2/>...<h4/> instead of <div/>
1807 - Allow output to validate against XHTML.
1808 - Don't use generate-id(), but instead generate member ID's manually so
1809 that we can properly refer to them from outside the current page.
1810 - Add support for <see cref=""/> translation to non-types --
1811 constructors, methods, properties, fields, events. These can refer to
1812 members from a different file, since generate-id() is no longer used.
1813 - Update the mono-docs site so links to System.* types work.
1814 - Add support for additional Mono.* namespaces on the mono-docs site.
1815 - Properly display C# indexers ("type this [params]", not
1816 "type Item [params]").
1817 - Generate documentation for <typeparam/> elements.
1818 * DocTest.cs: Added; Source for DocTest.dll, used by unit tests.
1819 * DocTest/html.expected/Mono.DocTest/Widget+NestedClass.html,
1820 DocTest/html.expected/Mono.DocTest/Widget+NestedClass`1.html,
1821 DocTest/html.expected/Mono.DocTest/Widget+IMenuItem.html,
1822 DocTest/html.expected/Mono.DocTest/DocValueType.html,
1823 DocTest/html.expected/Mono.DocTest/IProcess.html,
1824 DocTest/html.expected/Mono.DocTest/index.html,
1825 DocTest/html.expected/Mono.DocTest/Widget+Direction.html,
1826 DocTest/html.expected/Mono.DocTest/Color.html,
1827 DocTest/html.expected/Mono.DocTest/Widget+Del.html,
1828 DocTest/html.expected/Mono.DocTest/UseLists.html,
1829 DocTest/html.expected/Mono.DocTest/Widget.html,
1830 DocTest/html.expected/Mono.DocTest.Generic/MyList`1+Helper`2.html,
1831 DocTest/html.expected/Mono.DocTest.Generic/index.html,
1832 DocTest/html.expected/Mono.DocTest.Generic/MyList`1.html,
1833 DocTest/html.expected/Mono.DocTest.Generic/MyList`2.html,
1834 DocTest/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
1835 DocTest/html.expected/index.html,
1836 DocTest/en.expected/Mono.DocTest.Generic.xml,
1837 DocTest/en.expected/Mono.DocTest/Widget+IMenuItem.xml,
1838 DocTest/en.expected/Mono.DocTest/IProcess.xml,
1839 DocTest/en.expected/Mono.DocTest/Widget.xml,
1840 DocTest/en.expected/Mono.DocTest/Widget+NestedClass`1.xml,
1841 DocTest/en.expected/Mono.DocTest/DocValueType.xml,
1842 DocTest/en.expected/Mono.DocTest/Widget+Direction.xml,
1843 DocTest/en.expected/Mono.DocTest/Widget+NestedClass.xml,
1844 DocTest/en.expected/Mono.DocTest/Widget+Del.xml,
1845 DocTest/en.expected/Mono.DocTest/UseLists.xml,
1846 DocTest/en.expected/Mono.DocTest/Color.xml,
1847 DocTest/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
1848 DocTest/en.expected/Mono.DocTest.Generic/MyList`1.xml,
1849 DocTest/en.expected/Mono.DocTest.Generic/MyList`2.xml,
1850 DocTest/en.expected/Mono.DocTest.Generic/MyList`1+Helper`2.xml,
1851 DocTest/en.expected/index.xml, DocTest/en.expected/Mono.DocTest.xml:
1852 Added. Expected output for monodocer (en.expected) and
1853 monodocs2html (html.expected).
1855 2006-04-01 Joshua Tauberer <tauberer@for.net>
1857 * monodocs2html.cs: Skip files that are missing.
1859 2006-03-09 Joshua Tauberer <tauberer@for.net>
1861 * monodocer.cs: Reverted all of the Cecil changes. Ah well.
1863 2006-03-04 Joshua Tauberer <tauberer@for.net>
1865 * monodocer.cs: Using Cecil now! (Some Cecil fixes
1866 need to be committed.)
1868 2006-03-03 Joshua Tauberer <tauberer@for.net>
1870 * monodocer.cs: Don't change up whitespace unless user says so.
1871 That makes it hard to see differences against svn.
1873 2006-01-12 Jonathan Pryor <jonpryor@vt.edu>
1875 * bsd-man-to-ecma.pl, bsd-man-to-exception.pl: Added; scripts to help
1876 convert BSD man pages into ECMA XML formats. Run `perldoc PROGRAM` for
1877 program documentation.
1878 * Makefile.am: Add bsd-man-to-ecma.pl and bsd-man-to-exception.pl to
1881 2005-08-11 Dan Winship <danw@novell.com>
1883 * monodocer.cs: Don't preserve whitespace when reading the old
1884 doc, and don't add any whitespace when creating the new doc. Just
1885 let the XmlTextWriter handle indentation and it will all just
1888 2005-08-03 Atsushi Enomoto <atsushi@ximian.com>
1890 * monodocer.cs : update name attribute in paramref elements in sync
1891 with that of param element.
1893 2005-07-09 Joshua Tauberer <tauberer@for.net>
1895 From Rodolfo Campero <rodolfo.campero@gmail.com>
1897 * monodocs2slashdoc.cs: Updated for changes in
1898 index.xml for documenting multiple assemblies.
1899 This app now writes out XML files for each assembly
1900 as well as NamespaceSummaries.xml to the working
1903 2005-06-12 Joshua Tauberer <tauberer@for.net>
1905 * monodocer.cs: Added --importslashdoc option to
1906 import the contents of /doc-generated xml docs
1907 into the generated files.
1909 2005-06-09 Joshua Tauberer <tauberer@for.net>
1911 * monodocer.cs : When documenting a single assembly,
1912 default the Title in index.xml to the name of the
1915 2005-06-04 Eric Butler <eric@extremeboredom.net>
1917 (copied from ChangeLog in parent directory)
1919 - Now exits with an exit code of 1 in the event of an error
1920 - Added '-name' command line argument
1921 - Use above argument for <Title> element
1923 2005-06-01 Joshua Tauberer <tauberer@for.net>
1925 * monodocer.cs : Old index.xml files need to have new nodes
1926 created for multiple assemblies, and the old Assembly and
1927 Attributes nodes removed. Added a Title element for 2html.
1929 * overview.xsl : Revised monodocs2html to use the Title
1930 element in index.xml for page titles, rather than the
1931 assembly name, which isn't available anymore since there
1932 may be more than one assembly.
1934 2005-05-23 Mike Kestner <mkestner@novell.com>
1936 * monodocer.cs : add multiple assembly updating.
1938 2005-05-09 Joshua Tauberer <tauberer@for.net>
1940 * Thanks for pushing me to use a ChangeLog.
1941 * Disallow documenting types in the root namespace (type.Namespace ==
1943 * When a <code> tag has a 'src' attribute, monodocer will replace
1944 the contents of the element with the text in the indicated file.
1945 the path is relative to the path given as the --path option.
1946 * Properties that have different access modifiers on their accessors
1947 are now given signatures that reflect that. (But Monodoc doesn't
1948 recognize this properly. A format change is needed.)
1949 * monodocs2html: Create the destination directory if it doesn't exist.
1951 2005-01-29 Jonathan Pryor <jonpryor@vt.edu>
1954 * monodocer.cs (GetTypeFileName): Add check for type.Namespace == null.
1955 Fixes NullReferenceException when trying to update Mono.Posix.dll.
projects / mono.git / blob