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