Command reference

edit

Synopsis

Meziantou.Framework.PublicApiGenerator.Tool [options]

Description

Generate public API stubs from a .NET assembly.

Options

OptionDescriptionDefault
--input <input> (REQUIRED)Assembly input. Use either 'path' or 'tfm=path'. Repeat for multi-target generation.
--output <output>Output directory
--output-file <output-file>Output file path when --file-layout is SingleFile
--file-layout <OneFilePerNamespace\|OneFilePerType\|SingleFile>File layout: SingleFile, OneFilePerNamespace, or OneFilePerTypeSingleFile
--omit-auto-generated-commentOmit the // <auto-generated/> comment from generated files
--include-assembly-referencesList the names of the referenced assemblies in the header of generated files. With a .deps.json file, the assemblies of the framework are not listed
--include-assembly-reference <include-assembly-reference>Pattern of the names of the framework assemblies to list with --include-assembly-references ('*' and '?' wildcards). Repeat for several patterns.
--exclude-assembly-reference <exclude-assembly-reference>Pattern of the names of the assemblies not to list with --include-assembly-references ('*' and '?' wildcards). Repeat for several patterns.
--include-all-attributesWrite the attributes that are not written by default: EditorBrowsable, the attributes of other namespaces than System, and the assembly attributes
--delete-unexpected-filesDelete the files of the --output directory that are not generated, such as the files of removed types. Only use it when the directory only contains the generated files
--verify-no-changeVerify generated files are up to date without writing changes
-?, -h, --helpShow help and usage information
--versionShow version information