DscResource.DocGenerator

0.9.0-preview0002

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.9.0-preview0002 -AllowPrerelease

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name DscResource.DocGenerator -Version 0.9.0-preview0002 -Prerelease

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

Owners

Copyright

(c) DSC Community contributors.

Package Details

Author(s)

  • DSC Community

Tags

DSC Modules documentation

Functions

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

Dependencies

This module has no dependencies.

Release Notes

## [0.9.0-preview0002] - 2021-06-16

### Added

- Added private functions:
 - `Get-ClassAst` - Returns the AST for a single or all classes.
 - `Get-ClassResourceAst` - Returns the AST for a single or all DSC class
   resources.
 - `Get-ClassResourceProperty` - Returns DSC class resource properties
   from the provided class or classes.
 - `Format-Text` - Format a string according to predefined options.
 - `Get-TemporaryPath` - returns the appropriate temp path for the OS.

### Changed

- `New-DscResourceWikiPage`
 - If a class-based resource has a parent class that contains DSC resource
   properties they will now also be returned as part of the DSC resource
   parameters ([issue #62](https://github.com/dsccommunity/DscResource.DocGenerator/issues/62)).
 - Refactored to split into two private functions `New-DscMofResourceWikiPage` and
   `New-DscClassResourceWikiPage`.
- `Get-MofSchemaObject`
 - Refactored to reduce code duplication when adding functions for supporting
   composite resources.

### Fixed

- `Publish_GitHub_Wiki_Content`
 - Output message if `$GitHubToken` not specified which skips this task.
   Fixes [Issue 75](https://github.com/dsccommunity/DscResource.DocGenerator/issues/75)

FileList

Version History

Version Downloads Last updated
0.12.1 1,141 1/21/2024
0.12.1-previ... 4 1/21/2024
0.12.0 15 1/21/2024
0.12.0-previ... 23 1/19/2024
0.12.0-previ... 46 1/17/2024
0.12.0-previ... 25 1/14/2024
0.12.0-previ... 39 12/30/2023
0.11.2 6,451 1/3/2023
0.11.2-previ... 4 1/3/2023
0.11.1 2,466 8/9/2022
0.11.1-previ... 22 8/9/2022
0.11.1-previ... 21 8/1/2022
0.11.0 1,729 5/10/2022
0.11.0-previ... 22 5/9/2022
0.10.4-previ... 24 5/9/2022
0.10.4-previ... 22 5/9/2022
0.10.3 959 1/26/2022
0.10.3-previ... 22 1/26/2022
0.10.3-previ... 23 1/26/2022
0.10.2 30 1/25/2022
0.10.2-previ... 22 1/24/2022
0.10.1 667 10/19/2021
0.10.1-previ... 22 10/18/2021
0.10.1-previ... 23 8/7/2021
0.10.1-previ... 23 8/6/2021
0.10.0 605 8/5/2021
0.10.0-previ... 23 8/5/2021
0.9.1 361 7/14/2021
0.9.1-previe... 24 7/13/2021
0.9.0 67 7/8/2021
0.9.0-previe... 22 7/8/2021
0.9.0-previe... 22 7/8/2021
0.9.0-previe... 22 7/8/2021
0.9.0-previe... 23 7/7/2021
0.9.0-previe... 22 7/6/2021
0.9.0-previe... 23 7/6/2021
0.9.0-previe... 28 7/6/2021
0.9.0-previe... 23 6/26/2021
0.9.0-previe... 22 6/25/2021
0.9.0-previe... 23 6/20/2021
0.9.0-previe... 22 6/19/2021
0.9.0-previe... (current version) 23 6/16/2021
0.9.0-previe... 22 6/8/2021
0.8.4-previe... 22 6/3/2021
0.8.3 1,513 4/10/2021
0.8.2 519 3/19/2021
0.8.1 157 3/11/2021
0.8.1-previe... 24 3/11/2021
0.8.0 535 2/8/2021
0.8.0-previe... 27 2/7/2021
0.7.4 81 2/2/2021
0.7.4-previe... 25 2/2/2021
0.7.3 28 2/2/2021
0.7.3-previe... 24 2/2/2021
0.7.3-previe... 24 1/18/2021
0.7.2 224 1/17/2021
0.7.2-previe... 25 1/17/2021
0.7.1 1,200 8/5/2020
0.7.1-previe... 23 8/5/2020
0.7.0 267 7/8/2020
0.7.0-previe... 23 7/8/2020
0.6.1 138 7/1/2020
0.6.1-previe... 23 7/1/2020
0.6.1-previe... 23 6/26/2020
0.6.0 121 6/22/2020
0.6.0-previe... 24 6/22/2020
0.6.0-previe... 23 6/20/2020
0.5.2-previe... 24 6/16/2020
0.5.1 1,279 5/1/2020
0.5.1-previe... 23 5/1/2020
0.5.0 630 3/28/2020
0.5.0-previe... 25 3/27/2020
0.4.1-previe... 25 2/26/2020
0.4.0 173 2/25/2020
0.4.0-previe... 25 2/25/2020
0.4.0-previe... 25 2/25/2020
0.4.0-previe... 25 2/18/2020
0.3.0 51 2/11/2020
0.3.0-previe... 25 2/11/2020
0.2.0 31 2/6/2020
0.1.1 29 2/2/2020
0.1.1-previe... 29 2/2/2020
Show less