DscResource.DocGenerator
0.9.0-preview0004
Functionality to help generate documentation for modules.
Minimum PowerShell version
5.0
See the version list below for details.
Installation Options
Owners
Copyright
(c) DSC Community contributors.
Package Details
Author(s)
- DSC Community
Tags
Functions
New-DscResourcePowerShellHelp New-DscResourceWikiPage Publish-WikiContent Set-WikiModuleVersion Split-ModuleVersion
Dependencies
This module has no dependencies.
Release Notes
## [0.9.0-preview0004] - 2021-06-20
### 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.
- `Get-ConfigurationAst` - Returns the AST for a single or all configurations.
- `Get-CompositeSchemaObject` - Returns an object containing the parameters
and other properties related to a composite resource. The object that is
returned is different format to a MOF or class-based object and the property
names are aligned to a configuration parameter block rather than MOF.
- `Get-CompositeResourceParameterState` - Determines the parameter state of a
composite resource parameter. This is a meta attribute that will either be
`Required` or `Write`.
- `Get-CompositeResourceParameterValidateSet` - Returns the array of values
contained in the ValidateSet parameter attributes if it exists.
### 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.
- Converted `Invoke-Git` cmdlet to use `System.Diagnostics.Process` for improved error handling.
- `Get-ClassResourceCommentBasedHelp`
- Renamed this function to `Get-CommentBasedHelp` so that it made sense to
use with composite DSC resources.
- Enabled the function to extract the comment block if it is not at the top
of the script file to support 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
- DscResource.DocGenerator.nuspec
- tasks\Generate_Conceptual_Help.build.ps1
- DscResource.DocGenerator.psm1
- tasks\Generate_Wiki_Content.build.ps1
- Modules\DscResource.Common\0.2.0\DscResource.Common.psd1
- DscResource.DocGenerator.psd1
- Modules\DscResource.Common\0.2.0\DscResource.Common.psm1
- en-US\DscResource.DocGenerator.strings.psd1
- Modules\DscResource.Common\0.2.0\en-US\DscResource.Common.psd1
- en-US\about_DscResource.DocGenerator.help.txt
- Modules\DscResource.Common\0.2.0\en-US\about_DscResource.Common.help.txt
- tasks\Publish_GitHub_Wiki_Content.build.ps1
Version History
Version | Downloads | Last updated |
---|---|---|
0.13.0 | 7,840 | 2/28/2025 |
0.13.0-previ... | 107 | 11/17/2024 |
0.13.0-previ... | 35 | 10/26/2024 |
0.13.0-previ... | 6 | 10/23/2024 |
0.13.0-previ... | 48 | 10/20/2024 |
0.12.5 | 3,716 | 8/14/2024 |
0.12.5-previ... | 7 | 8/14/2024 |
0.12.5-previ... | 7 | 8/13/2024 |
0.12.4 | 1,789 | 6/3/2024 |
0.12.4-previ... | 7 | 6/3/2024 |
0.12.3 | 68 | 6/1/2024 |
0.12.3-previ... | 7 | 6/1/2024 |
0.12.2 | 69 | 5/31/2024 |
0.12.2-previ... | 6 | 5/31/2024 |
0.12.2-previ... | 15 | 5/29/2024 |
0.12.1 | 1,963 | 1/21/2024 |
0.12.1-previ... | 9 | 1/21/2024 |
0.12.0 | 21 | 1/21/2024 |
0.12.0-previ... | 28 | 1/19/2024 |
0.12.0-previ... | 51 | 1/17/2024 |
0.12.0-previ... | 30 | 1/14/2024 |
0.12.0-previ... | 44 | 12/30/2023 |
0.11.2 | 7,239 | 1/3/2023 |
0.11.2-previ... | 9 | 1/3/2023 |
0.11.1 | 2,471 | 8/9/2022 |
0.11.1-previ... | 27 | 8/9/2022 |
0.11.1-previ... | 26 | 8/1/2022 |
0.11.0 | 1,734 | 5/10/2022 |
0.11.0-previ... | 27 | 5/9/2022 |
0.10.4-previ... | 28 | 5/9/2022 |
0.10.4-previ... | 27 | 5/9/2022 |
0.10.3 | 964 | 1/26/2022 |
0.10.3-previ... | 27 | 1/26/2022 |
0.10.3-previ... | 28 | 1/26/2022 |
0.10.2 | 35 | 1/25/2022 |
0.10.2-previ... | 26 | 1/24/2022 |
0.10.1 | 672 | 10/19/2021 |
0.10.1-previ... | 27 | 10/18/2021 |
0.10.1-previ... | 28 | 8/7/2021 |
0.10.1-previ... | 28 | 8/6/2021 |
0.10.0 | 610 | 8/5/2021 |
0.10.0-previ... | 28 | 8/5/2021 |
0.9.1 | 366 | 7/14/2021 |
0.9.1-previe... | 29 | 7/13/2021 |
0.9.0 | 72 | 7/8/2021 |
0.9.0-previe... | 27 | 7/8/2021 |
0.9.0-previe... | 27 | 7/8/2021 |
0.9.0-previe... | 27 | 7/8/2021 |
0.9.0-previe... | 28 | 7/7/2021 |
0.9.0-previe... | 27 | 7/6/2021 |
0.9.0-previe... | 28 | 7/6/2021 |
0.9.0-previe... | 33 | 7/6/2021 |
0.9.0-previe... | 28 | 6/26/2021 |
0.9.0-previe... | 27 | 6/25/2021 |
0.9.0-previe... (current version) | 28 | 6/20/2021 |
0.9.0-previe... | 27 | 6/19/2021 |
0.9.0-previe... | 27 | 6/16/2021 |
0.9.0-previe... | 27 | 6/8/2021 |
0.8.4-previe... | 27 | 6/3/2021 |
0.8.3 | 1,525 | 4/10/2021 |
0.8.2 | 524 | 3/19/2021 |
0.8.1 | 162 | 3/11/2021 |
0.8.1-previe... | 29 | 3/11/2021 |
0.8.0 | 540 | 2/8/2021 |
0.8.0-previe... | 32 | 2/7/2021 |
0.7.4 | 86 | 2/2/2021 |
0.7.4-previe... | 30 | 2/2/2021 |
0.7.3 | 33 | 2/2/2021 |
0.7.3-previe... | 29 | 2/2/2021 |
0.7.3-previe... | 29 | 1/18/2021 |
0.7.2 | 229 | 1/17/2021 |
0.7.2-previe... | 30 | 1/17/2021 |
0.7.1 | 1,205 | 8/5/2020 |
0.7.1-previe... | 28 | 8/5/2020 |
0.7.0 | 272 | 7/8/2020 |
0.7.0-previe... | 28 | 7/8/2020 |
0.6.1 | 143 | 7/1/2020 |
0.6.1-previe... | 28 | 7/1/2020 |
0.6.1-previe... | 28 | 6/26/2020 |
0.6.0 | 126 | 6/22/2020 |
0.6.0-previe... | 29 | 6/22/2020 |
0.6.0-previe... | 28 | 6/20/2020 |
0.5.2-previe... | 29 | 6/16/2020 |
0.5.1 | 1,284 | 5/1/2020 |
0.5.1-previe... | 28 | 5/1/2020 |
0.5.0 | 635 | 3/28/2020 |
0.5.0-previe... | 30 | 3/27/2020 |
0.4.1-previe... | 30 | 2/26/2020 |
0.4.0 | 178 | 2/25/2020 |
0.4.0-previe... | 30 | 2/25/2020 |
0.4.0-previe... | 30 | 2/25/2020 |
0.4.0-previe... | 30 | 2/18/2020 |
0.3.0 | 56 | 2/11/2020 |
0.3.0-previe... | 30 | 2/11/2020 |
0.2.0 | 36 | 2/6/2020 |
0.1.1 | 34 | 2/2/2020 |
0.1.1-previe... | 34 | 2/2/2020 |