DscResource.DocGenerator

0.8.0-preview0001

Functionality to help generate documentation for modules.

Minimum PowerShell version

5.0

This is a prerelease version of DscResource.DocGenerator.
There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name DscResource.DocGenerator -RequiredVersion 0.8.0-preview0001 -AllowPrerelease

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

DSC Community

Copyright

(c) DSC Community contributors.

Owners

Tags

DSC Modules documentation

Functions

New-DscResourcePowerShellHelp New-DscResourceWikiPage Publish-WikiContent Set-WikiModuleVersion Split-ModuleVersion

Dependencies

This module has no dependencies.

Release Notes

## [0.8.0-preview0001] - 2021-02-07

### Added

- Added a new private function `Get-ClassResourceCommentBasedHelp` to get
 comment-based help from a PowerShell script file.
- Added a new private function `Get-ClassResourcePropertyState` to get
 named attribute argument (from the attribute `[DscProperty()]`) for a
 class-based resource parameter and return the corresponding name used by
 MOF-based resources.
- Added a new private function `Get-ResourceExampleAsMarkdown` that helps
 to return examples as markdown, and to reduce code duplication.
- Added a test helper module `DscResource.DocGenerator.TestHelper.psm1`
 that contain helper functions for tests.
 - Added helper function `Out-Diff` that outputs two text strings in hex
   side-by-side (thanks to [@johanringman](https://github.com/johanringman)
   for help with this one).

### Changed

- `Split-ModuleVersion`
 - This cmdlet is now exported as a public function because it is required
   by the build task `Generate_Wiki_Content`.
- `Generate_Wiki_Content`
 - The Build task `Generate_Wiki_Content` was changed to call the cmdlet
   `New-DscResourceWikiPage` with the correct parameters to support generating
   documentation for class-based resource ([issue #52](https://github.com/dsccommunity/DscResource.DocGenerator/issues/52)).
- `New-DscResourceWikiPage`
 - Now supports generating wiki documentation for class-based resources
   ([issue #52](https://github.com/dsccommunity/DscResource.DocGenerator/issues/52)).
 - **BREAKING CHANGE:** To support class-based resource the parameters were
   renamed to better recognize what path goes where.
 - Each values that are in a `ValueMap` of a MOF schema parameter, or in
   a `ValidateSet()` of a class-based resource parameter, will be outputted
   as markdown inline code.

### Fixed

- `Get-ResourceExampleAsText`
 - Comment-based help was updated to reflect the correct parameters.
- `New-DscResourcePowerShellHelp`
 - Fixed unit tests to support new private function `Get-ClassResourceCommentBasedHelp`
   and use the test helper module `DscResource.DocGenerator.TestHelper.psm1`.
 - It no longer uses `Recurse` when looking for the module's PowerShell
   script files. It could potentially lead to that it found resources that
   are part of common modules in the `Modules` folder.
 - Made use of private functions to reduce duplicate code.
- `Get-DscResourceSchemaPropertyContent`
 - Fixed the private function so that the description property no longer
   output an extra whitespace in some circumstances.

Version History

Version Downloads Last updated
0.10.1 244 10/19/2021
0.10.1-previ... 2 10/18/2021
0.10.1-previ... 3 8/7/2021
0.10.1-previ... 2 8/6/2021
0.10.0 584 8/5/2021
0.10.0-previ... 2 8/5/2021
0.9.1 340 7/14/2021
0.9.1-previe... 2 7/13/2021
0.9.0 46 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/8/2021
0.9.0-previe... 2 7/7/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 7/6/2021
0.9.0-previe... 2 6/26/2021
0.9.0-previe... 2 6/25/2021
0.9.0-previe... 2 6/20/2021
0.9.0-previe... 2 6/19/2021
0.9.0-previe... 2 6/16/2021
0.9.0-previe... 2 6/8/2021
0.8.4-previe... 2 6/3/2021
0.8.3 1,439 4/10/2021
0.8.2 498 3/19/2021
0.8.1 137 3/11/2021
0.8.1-previe... 4 3/11/2021
0.8.0 514 2/8/2021
0.8.0-previe... (current version) 7 2/7/2021
0.7.4 60 2/2/2021
0.7.4-previe... 4 2/2/2021
0.7.3 7 2/2/2021
0.7.3-previe... 4 2/2/2021
0.7.3-previe... 4 1/18/2021
0.7.2 203 1/17/2021
0.7.2-previe... 5 1/17/2021
0.7.1 1,179 8/5/2020
0.7.1-previe... 3 8/5/2020
0.7.0 245 7/8/2020
0.7.0-previe... 3 7/8/2020
0.6.1 117 7/1/2020
0.6.1-previe... 3 7/1/2020
0.6.1-previe... 3 6/26/2020
0.6.0 100 6/22/2020
0.6.0-previe... 3 6/22/2020
0.6.0-previe... 3 6/20/2020
0.5.2-previe... 4 6/16/2020
0.5.1 1,258 5/1/2020
0.5.1-previe... 3 5/1/2020
0.5.0 609 3/28/2020
0.5.0-previe... 4 3/27/2020
0.4.1-previe... 5 2/26/2020
0.4.0 152 2/25/2020
0.4.0-previe... 5 2/25/2020
0.4.0-previe... 5 2/25/2020
0.4.0-previe... 5 2/18/2020
0.3.0 30 2/11/2020
0.3.0-previe... 5 2/11/2020
0.2.0 10 2/6/2020
0.1.1 7 2/2/2020
0.1.1-previe... 5 2/2/2020
Show less