Sponsoring

Install

dotnet tool install --global dotMorten.OmdGenerator

Usage:

generateomd /source=[source folder] /compareSource=[oldSourceFolder] /preprocessors=[defines] /format=[html|image] /showPrivate /showInternalRequired parameters:  source            Specifies the folder of source files to include for the object model.                    Separate with ; for multiple foldersor  assemblies        Specifies a set of assemblies to include for the object model.                    Separate with ; for multiple assemblies, or use wildcardsOptional parameters:  compareSource     Specifies a folder of old source to compare and generate a diff model                    This can be useful for finding API changes or compare branches  compareAssemblies Specifies a set of old assemblies to compare and generate a adiff model.                    Separate with; for multiple assemblies, or use wildcards  format            Format to generate:                        'html' a single html output (html is default)                       'md' for markdown you can copy-paste to for instance GitHub.       Specify multiple with a semicolon seperator, and use an output filename without extension  preprocessors     Define a set of preprocessors values. Use ; to separate multiple  exclude           Defines one or more strings that can't be part of the path Ie '*/Samples/*;*/UnitTests/*'                    (use forward slash for folder separators)  regexfilter       Defines a regular expression for filtering on full file names in the source  showPrivate       Show private members (default is false)  showInternal      Show internal members (default is false)  output            Filename to write the output to (extension is optional, but exclude the extension if you specify multiple formats)

NuGet

Install-Package dotMorten.OmdGenerator

  <TargetName="GenerateObjectModel"AfterTargets="Compile">    <ExecCommand="dotnet&quot;$(DotNetOMDGeneratorToolPath)&quot; /source=&quot;@(Compile)&quot; /preprocessors=&quot;$(DefineConstants)&quot; /output=&quot;$(OutputPath)$(TargetName)&quot;"WorkingDirectory="$(ProjectDir)" />  </Target>

Examples

generateomd /source=c:\github\dotnet\corefx\src /exclude="*/ref/*;*/tests/*;*/perftests/*"

generateomd /source=https://github.com/dotnet/corefx/archive/master.zip /compareSource=https://github.com/dotnet/corefx/archive/release/2.0.0.zip /exclude="*/ref/*;*/tests/*;*/perftests/*"

generateomd /assemblies=%USERPROFILE%\.nuget\packages\xamarin.forms\3.3.0.912540\lib\netstandard2.0\*.dll /compareAsssemblies=%USERPROFILE%\.nuget\packages\xamarin.forms\3.2.0.871581\lib\netstandard2.0\*.dll