Age | Commit message (Collapse) | Author |
|
different return types in different frameworks will now
have the FrameworkAlternate attribute added to it
|
|
An updated local version of mdoc started causing test output changes which clashed with the CI build agent's config. So this change removes this functionality from the integration tests, and adds a few unit tests that tests the exception functionality. Closes #341
|
|
|
|
Removed namespace when return type is generic
Added integration tests
Added unit test
Add RefType attribute to ReturnType element
Closes #230
|
|
Closes #118
|
|
Closes #6
|
|
recent XML changes
The XML work in 661430fd1f052c5589bcd5d116f37b9ee4e27210 and bf39f5aec034800abcfe5e73a63ddd1414cb8078 changed the whitespace handling, so the mdoc test suite failed.
Refreshing the files makes them identical to what MS.NET produces and fixes the mdoc tests.
|
|
|
|
|
|
3d3fe6af (among other commits...) "broke" the `mdoc` unit tests, as it
did two things:
1. It added a new codepath calling string.Format(), thus introducing
a new set of exceptions.
2. Due to an `mdoc` bug, (1) resulted in a stack overflow on OS X.
(1) demonstrates that the mdoc unit tests might be too brittle.
(2) was fixed in 04bf9ad.
The problem with 04bf9ad, though, is that it resulted in a gigantic
~212MB diff, because while the recursion was "fixed", we could still
process the same method multiple times, resulting in _lots_ of
duplication, e.g. System.String.get_Chars() would be repeated hundreds
of times for a given exception.
Improve the source reporting mechanism so that instead of a
List<MemberReference> we use a HashSet<MemberReference>, listing each
source location _once_ instead of repeating them.
The _formatting_ of the <exception/> element is also changed so that
each source location is on its own line, making it easier to read and
review the locations.
|
|
|
|
(Yet another "Let's help ECMA!" fix...)
For performance reasons, I want to use this workflow:
mdoc x-msitomsx -o slashdocs msidocs --type=A
mdoc update -o docs -i slashdocs/mscorlib.xml mscorlib.dll --type=A
mdoc update-ecma-xml -o CLILibraryTypes.xml --type=A
That is, have a consistent set of --type=TYPEs that are passed between the
three apps. I want to do this because otherwise 'mdoc update' takes
12 minutes to process the assemblies I need; with this approach, it takes
12 seconds.
Unfortunately, 'mdoc update-ecma-xml' needs an index.xml so it can obtain
assembly-level custom attributes, and 'mdoc update --type...' wasn't creating
an index.xml file.
Doh!
Fix: IFF docs/index.xml is NOT present, create a docs/index.xml file which
contains ONLY the types & namespaces that were encountered.
If docs/index.xml IS present, it's unchanged.
This fix allows the above workflow to Just Work, while maintaining the other
"I know this type has been updated, let's not process the entire assembly"
workflow that --type allows.
|
|
<exception/> generation.
* mdoc.exe.sources: Add Mono.Documentation/exceptions.cs to the build.
* Mono.Documentation/exceptions.cs: Added; searches through the
callgraph of an IMemberReference, recording which exception types
are created (and where they're created from).
* Mono.Documentation/monodocer.cs: Generate <exception/> elements.
* Test/DocTest-v1.cs: Modify some methods so that exceptions are
emitted (thus testing <exception/> generation).
* Test/DocTest-v2.patch: Update (so patch(1) doesn't complain).
* Test/en.expected.importecmadoc/System/Array.xml,
Test/en.expected.importecmadoc/System/Environment.xml,
Test/en.expected.importslashdoc/Mono.DocTest.Generic/GenericBase`1.xml,
Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml,
Test/en.expected.importslashdoc/Mono.DocTest/DocValueType.xml,
Test/en.expected.importslashdoc/Mono.DocTest/UseLists.xml,
Test/en.expected.importslashdoc/Mono.DocTest/Widget.xml,
Test/en.expected.importslashdoc/System/Array.xml,
Test/en.expected.importslashdoc/System/Environment.xml,
Test/en.expected.since/Mono.DocTest.Generic/GenericBase`1.xml,
Test/en.expected.since/Mono.DocTest/DocAttribute.xml,
Test/en.expected.since/Mono.DocTest/DocValueType.xml,
Test/en.expected.since/Mono.DocTest/UseLists.xml,
Test/en.expected.since/Mono.DocTest/Widget.xml,
Test/en.expected.since/System/Array.xml,
Test/en.expected.since/System/Environment.xml,
Test/en.expected/Mono.DocTest.Generic/GenericBase`1.xml,
Test/en.expected/Mono.DocTest/DocAttribute.xml,
Test/en.expected/Mono.DocTest/DocValueType.xml,
Test/en.expected/Mono.DocTest/UseLists.xml,
Test/en.expected/Mono.DocTest/Widget.xml,
Test/en.expected/System/Array.xml,
Test/en.expected/System/Environment.xml,
Test/html.expected/Mono.DocTest.Generic/GenericBase`1.html,
Test/html.expected/Mono.DocTest/DocAttribute.html,
Test/html.expected/Mono.DocTest/DocValueType.html,
Test/html.expected/Mono.DocTest/UseLists.html,
Test/html.expected/Mono.DocTest/Widget.html,
Test/html.expected/System/Array.html,
Test/html.expected/System/Environment.html,
Test/msxdoc-expected.importslashdoc.xml: Flush; adds <exception/>
elements (and/or HTML-rendered output of <exception/> elements).
svn path=/trunk/mcs/; revision=120501
|
|
* assembler.cs, mdoc.cs, monodocer.cs, monodocs2html.cs,
monodocs2slashdoc.cs, normalize.cs, validate.cs, XhtmlWriter.cs:
Move to Mono.Documentation.
* defaulttemplate.xsl, overview.xsl, stylesheet.xsl: Moved to
Resources.
* DocTest: Moved to Test.
* DocTest-v1.cs, DocTest-v2.patch, TestEcmaDocs.xml: Moved to Test.
* mdoc.exe.sources: Added; mcs include file to build mdoc.exe.
* Makefile: Added; build mdoc.exe, monodocer1.exe, and unit tests for
mdoc.exe
* Mono.Documentation/assembler.cs, Mono.Documentation/normalize.cs,
Mono.Documentation/mdoc.cs, Mono.Documentation/monodocs2slashdoc.cs,
Mono.Documentation/monodocs2html.cs, Mono.Documentation/validate.cs:
Modify command line handling to remove Mono.GetOptions dependency.
* Test/DocTest-v1.cs: Update //code/@src attribute due to changed paths.
* Test/msxdoc-expected.importslashdoc.xml,
* Test/en.expected.importslashdoc/Mono.DocTest/DocAttribute.xml: Flush
due to above DocTest-v1.cs change.
svn path=/trunk/mcs/; revision=116141
|