Releases: mono/api-doc-tools
[preview] mdoc v5.0.0.12
Same as v5.0.0.11, but with some minor additional error handling
[preview] mdoc v5.0.0.11
This release resolves an additional issue with explicitly implemented interfaces where it was not properly reflecting some members that changed to/from EII between frameworks.
[preview] mdoc v5.0.0.10
This release fixes a bug that was causing certain instances of duplicated members ... particularly with explicitly implemented members.
[preview] mdoc v5.0.0.9
This preview release builds upon the previous 5.0.0.x releases.
- Skips framework directories that do not exist.
- Improves cross-platform capability for framework search directories, in cases where a directory separator from another platform is used in the search directory path.
- Frameworks mode now uses a different comparison when evaluating when to add an extension method to the index file ... to avoid duplicates.
[preview] mdoc v5.0.0.8
This release contains a fix and builds upon previous preview builds:
- #39 - FrameworksIndex files contain members of base types in inheriting types
Base members that are overridden in some frameworks and not in others will no longer be removed.
[preview] mdoc v5.0.0.7
[preview] mdoc v5.0.0.6
Updated mono.cecil
[preview] mdoc v5.0.0.5
A big overhaul of "frameworks mode". In addition to the features below, all frameworks now use their own AssemblyResolver, so memory and number of open file handles are greatly reduced.
Frameworks Configuration File
Frameworks mode now requires an XML configuration file.
mdoc update -o out/path -fx path/to/frameworks/frameworks.xmlsample configuration file:
<?xml version="1.0" encoding="utf-8"?>
<Frameworks>
<Framework Name="One" Source="One">
<assemblySearchPath>dependencies/One</assemblySearchPath>
</Framework>
<Framework Name="Two" Source="Two">
<assemblySearchPath>dependencies/Two</assemblySearchPath>
</Framework>
</Frameworks>Note that the assemblySearchPath is meant to house dependent assemblies that mono.cecil must be able to resolve. You can have as many as you need for each framework if you happen to have them separated into multiple folders. Also the -L parameter applies globally to every framework.
Frameworks Config Bootstrap
To simplify the tedium of creating the configuration file, a simple command was added that will use the folder structure to create a basic configuration file:
mdoc fx-bootstrap path/to/frameworksThis will create a file at path/to/frameworks/frameworks.xml
DocId Signatures
You can now pass a flag to add a DocId signature to every Type and Member node.
mdoc update -o out/path some.dll -use-docid
please note: framework index files will always use the DocId as their identifiers as of this release.
Frameworks Index files Grouped by Namespace
Framework index files now have types grouped by namespace. Example:
<?xml version="1.0" encoding="utf-8"?>
<Framework Name="Two">
<Namespace Name="MyFramework.MyOtherNamespace">
<Type Name="MyFramework.MyOtherNamespace.MyOtherClass" Id="T:MyFramework.MyOtherNamespace.MyOtherClass">
<Member Id="M:MyFramework.MyOtherNamespace.MyOtherClass.#ctor" />
...
</Type>
</Namespace>
</Framework>[preview] mdoc v5.0.0.4
This release builds on the prior 5.0.0.* releases, and includes a fix for:
#6 - A more broadly applicable solution to the original problem.
[preview] mdoc v5.0.0.3
This release builds on the prior 5.0.0.* releases, and includes a fix for:
- #27 - Fixes an issue with duplicate extension methods when running in
-frameworksmode.