Skip to content

Releases: mono/api-doc-tools

mdoc 5.7.3.4

20 Sep 21:12
Compare
Choose a tag to compare

This release fixes a small regression in subdirectory resolution ... it wasn't recursing through dependency directories, which reduces mdoc's ability to properly resolve assemblies.

mdoc 5.7.3.3

19 Sep 20:16
Compare
Choose a tag to compare

This release contains the following fixes and improvements

  • #353 - improves assembly resolution, so that if mscorlib is not found, it will fall back to the version currently running mdoc.
  • assembly resolution exceptions now include the type that was being resolved (if you use --delete)
  • --quiet parameter for export-msxdoc now works

mdoc 5.7.3.2

12 Sep 18:44
Compare
Choose a tag to compare

The last release (5.7.3.2) included a crash under certain circumstances related to export type tracking. This patch improves the safety of the code in that section.

Additionally, it includes some performance improvements that should reduce caching time.

mdoc 5.7.3.1

12 Sep 15:49
Compare
Choose a tag to compare

This release contains the following fixes and improvements:

  • #342 - mdoc now tracks all exported types, and will list the assemblies that it's forwarded from, and the assembly that it's forwarded to.
  • Bug Fixes:
    • #340 - Improves attribute signatures when one of the parameters is an array of values.
    • #345 - Fixes a crash that occurs if an XML comment occurs in an unexpected place in the EcmaXml.

mdoc v5.7.3

22 Aug 00:22
Compare
Choose a tag to compare

You can also find this release on Nuget:
https://www.nuget.org/packages/mdoc/5.7.3

This release resolves the following issues and includes some additional enhancements:

  • #266 - Added code to sync parameter indices.
  • #304 - Added "ref modifier" back to docxml docids for 'Implements' section.
  • #333 - Fixed issue with the docs enumerator, which caused members with multiple EII to be missing in some cases.
  • #273 - [Serializable] attribute is now included for types.
  • Added a q|quiet parameter to the export-msxdoc subcommand, to reduce console logging.
  • Deleting files will now retry 10 times before throwing an exception. This was put in place to account for build agents with slow hard drives.

mdoc 5.7.2.3

01 Aug 22:13
Compare
Choose a tag to compare

This release is a minor point release above 5.7.2.2, and simply adjusts the member dupe removal algorithm slightly so that it can recover better, and has less of a chance of getting into an error state.

mdoc 5.7.2.2

26 Jul 15:11
Compare
Choose a tag to compare

This release contains the following fixes and improvements:

  • #295 - Fixes an issue matching members with ref/out parameters, which could result in duplication of members.
  • Additionally, removal of duplicate members is now a bit smarter, in that it will remove a duplicate that has non docs, instead of a member node that contains documentation. This results in better error-state recovery for future mdoc update runs.
  • #286 - AsyncStateMachine compiler-generated attributes are no longer added to output.

mdoc 5.7.2.1

20 Jul 02:49
Compare
Choose a tag to compare

This release fixes contains the following improvements:

  • #92 - Explicitly Implemented Members that use a custom name (VB) are now named using the same naming convention as C# EII members. There is an additional ExplicitInterfaceMemberName attribute on the Member node in these cases that have the custom name.
  • #293 - fixes NRE.
  • Additional minor perf improvement with assembly resolution.

mdoc 5.7.2

06 Jul 19:29
Compare
Choose a tag to compare
  • #230 - return type signature fixes: no longer prints the namespace for some generic type names, and adds RefType attribute to the ReturnType element
  • #194 - mdoc assemble now supports an -fx argument, which is the name of the framework (when in frameworks mode) to assemble. This will exclude any types and members that are not in that framework from the resulting .tree and .zip
  • Fixes an issue with HTML output, in which some instances of generics would result in an infinite loop in the XSL processing.

mdoc 5.7.1

28 Jun 19:09
Compare
Choose a tag to compare

This release resolves #76, by adding FrameworkAlternate attributes to any attribute that doesn't exist in all frameworks. Here's an example of what that will look like in the corresponding EcmaXml:

  <Attributes>
    <Attribute FrameworkAlternate="xamarinandroid-7.1;xamarinios-10.8;xamarinmac-3.0">
      <AttributeName>System.Obsolete("SmtpClient and its network of types are poorly designed, we strongly recommend you use https://github.com/jstedfast/MailKit and https://github.com/jstedfast/MimeKit instead")</AttributeName>
    </Attribute>
  </Attributes>