XmlDoc2CmdletDoc 0.3.0

Tool used to generate .dll-Help.xml help files for binary PowerShell modules from XML Doc comments. Licensed under the terms of the new 3-clause BSD license.

There is a newer prerelease version of this package available.
See the version list below for details.
Install-Package XmlDoc2CmdletDoc -Version 0.3.0
dotnet add package XmlDoc2CmdletDoc --version 0.3.0
<PackageReference Include="XmlDoc2CmdletDoc" Version="0.3.0">
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add XmlDoc2CmdletDoc --version 0.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

# 0.3.0

- Use Microsoft.PowerShell.5.ReferenceAssemblies instead of a legacy version of System.Management.Automation.
- Added support for globbing/wildcards based on the presence of SupportsWildcardsAttribute.

# 0.2.13

- Correctly resolve type descriptions for array-typed parameters.

# 0.2.12

- Extended the support for documenting parameters of type `Enum` to include parameters of type `IEnumerable<T> where T : Enum`.

# 0.2.11

- Added support for dynamic parameters.

# 0.2.10

- Parameters marked with the [Obsolete] attribute no longer appear in the cmdlet syntax summary, though it's still possible to provide help text for the parameter, which can be viewed using the `-Parameter` switch of the `Get-Help` cmdlet.

- Added support for excluding parameter sets by name, via a new command-line option and corresponding msbuild property.

# 0.2.9

- Fixed issue #39. Corrected a regression for the default value of string parameters.

# 0.2.8

- Partially addressed issues #33 and #37. Slightly improved handling of default values and array parameters. More work is required in this area, though.

# 0.2.7

- Fixed issue #31. MSBuild task now accommodates binary modules that are specifically targeted at only x86 or x64 architectures.

# 0.2.6

- Fixed issue #28. Ensure that help syntax is correctly displayed for parameterless cmdlets.

# 0.2.5

- Added limited support for documenting dynamic parameters. If a cmdlet implements IDynamicParameters, and its GetDynamicParameters method returns an instance of a nested type within the cmdlet, then help documentation will be extracted from the nested type's XML Doc comments.

# 0.2.4

- Fixed issue #22. When encountering a Parameter with no getter, XmlDoc2CmdletDoc now records a warning that the default value for the Parameter cannot be obtained. Previously this raised a fatal exception.

# 0.2.3

- XmlDoc2CmdletDoc now executes prior to the AfterBuild target, rather than prior to the PostBuildEvent target, to give developers the option to copy files around in either target, rather than only in the latter.

# 0.2.2

- Fixed issue #19: Help for cmdlet parameters is now explicitly ordered by Position, then Required, then Name, rather than relying on the arbitrary order of Type.GetMembers.

# 0.2.1

- First public release.


This package has no dependencies.

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on XmlDoc2CmdletDoc:

Repository Stars
Set of tools to analyze Windows sandboxes for exposed attack surface.
X41 Browser Security White Paper - Tools and PoCs
C#/PowerShell interface for PRTG Network Monitor
Native PowerShell support for invoking Microsoft Intune Graph API to enable IT Pro scenario automation.

Version History

Version Downloads Last updated
0.4.0-dotnetcore0000 0 7/8/2020
0.3.0 0 7/8/2020
0.3.0-use-reference-as0000 50 6/30/2020
0.3.0-dotnetcore0001 0 7/7/2020
0.2.13 26,072 8/5/2019
0.2.12 12,444 3/5/2019
0.2.11 179 3/5/2019
0.2.10 26,989 1/9/2018
0.2.9 8,951 9/22/2017
0.2.8 424 9/11/2017
0.2.7 10,250 2/3/2017
0.2.7-Support32Bit001 347 2/2/2017
0.2.7-Fix64BitAssemblyLoad 361 2/1/2017
0.2.6 439 1/16/2017
0.2.5 752 11/19/2016
0.2.4 2,378 7/16/2016
0.2.3 5,218 4/29/2016
0.2.2 415 4/27/2016
0.2.1 452 4/14/2016
0.2.0 430 4/12/2016