Application: mddocs
Generate API reference documentation for a .NET assembly.
mddocs apireference [--assemblies|-a <VALUE>]
[--configurationFilePath|-c <VALUE>]
[--outdir|-o <VALUE>]
[--verbose|-v]| Name | Short Name | Description |
|---|---|---|
| assemblies | a | Path of the assemblies to generate documentation for (at least one assembly must be specified). |
| configurationFilePath | c | The path of the configuration file to use. If no configuration file is specified, default settings are used. |
| outdir | o | Path of the directory to write the documentation to. If the output directory already exists, all files in the output directory will be deleted. |
| verbose | v | Show more detailed log output. |
Path of the assemblies to generate documentation for (at least one assembly must be specified).
| Name: | assemblies |
| Short name: | a |
| Position: | Named parameter |
| Required: | No |
| Default value: | None |
The path of the configuration file to use. If no configuration file is specified, default settings are used.
| Name: | configurationFilePath |
| Short name: | c |
| Position: | Named parameter |
| Required: | No |
| Default value: | None |
Path of the directory to write the documentation to. If the output directory already exists, all files in the output directory will be deleted.
| Name: | outdir |
| Short name: | o |
| Position: | Named parameter |
| Required: | No |
| Default value: | None |
Show more detailed log output.
| Name: | verbose |
| Short name: | v |
| Position: | None (Switch Parameter) |
| Required: | No (Switch Parameter) |
| Default value: | false |
Documentation generated by MdDocs