Skip to content

Releases: mono/api-doc-tools

[preview] mdoc v5.0.0.2

18 Feb 02:18

Choose a tag to compare

Pre-release

Building on preview v5.0.0.1 (release notes), this additionally includes fixes for:

  • #6 - [mdoc] Error updating a generic extension method
  • #7 - [mdoc] Error when running on a folder with some assemblies being non-managed
  • #12 - [mdoc] Support extra elements in the generated ECMAXML

[preview] mdoc v5.0.0.1

13 Feb 22:08

Choose a tag to compare

Pre-release

mdoc now supports documenting multiple frameworks (PR here). You can use this new functionality by passing the path to a directory in the -frameworks parameter.

mdoc update -o path/to/documentationXML -frameworks path/to/frameworks

The names of the folders in path/to/frameworks will be used as the name of the frameworks. And will result in one XML file per framework in the path/to/documentationXML/FrameworksIndex folder.

<?xml version="1.0" encoding="utf-8"?>
<Framework Name="One">
  <Type Name="MyFramework.MyNamespace.MyClass">
    <Member Sig="public double OnlyInClassic { get; set; }" />
    <Member Sig="public float Hello (int value);" />
    <Member Sig="public MyClass ();" />
    <Member Sig="public string MyProperty { get; set; }" />
  </Type>
  <Type Name="MyFramework.MyNamespace.MyClassExtensions">
    <Member Sig="public static bool AnExtension (this MyFramework.MyNamespace.MyClass value);" />
  </Type>
  <Type Name="MyNamespace.MyClass">
    <Member Sig="public MyClass ();" />
    <Member Sig="public string SomeMethod&lt;T&gt; ();" />
  </Type>
</Framework>