DscResource.DocGenerator.psd1
|
@{ # Script module or binary module file associated with this manifest. RootModule = 'DscResource.DocGenerator.psm1' # Version number of this module. ModuleVersion = '0.8.0' GUID = 'fa8b017d-8e6e-414d-9ab7-c8ab9cb9e9a4' # Author of this module Author = 'DSC Community' # Company or vendor of this module CompanyName = 'DSC Community' # Copyright statement for this module Copyright = '(c) DSC Community contributors.' # Description of the functionality provided by this module Description = 'Functionality to help generate documentation for modules.' # Minimum version of the Windows PowerShell engine required by this module PowerShellVersion = '5.0' <# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. This will be automatically update by the build pipeline. #> FunctionsToExport = @('New-DscResourcePowerShellHelp','New-DscResourceWikiPage','Publish-WikiContent','Set-WikiModuleVersion','Split-ModuleVersion') <# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. #> CmdletsToExport = @() # Variables to export from this module VariablesToExport = @() <# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. This must be set to the aliases to export since there is no way to tell the module builder (build pipeline) which aliases to add. #> AliasesToExport = @( 'Task.Generate_Conceptual_Help', 'Task.Generate_Wiki_Content', 'Task.Publish_GitHub_Wiki_Content' ) # DSC resources to export from this module DscResourcesToExport = @() <# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. #> PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. Tags = 'DSC', 'Modules', 'documentation' # A URL to the license for this module. LicenseUri = 'https://github.com/dsccommunity/DscResource.DocGenerator/blob/main/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://github.com/dsccommunity/DscResource.DocGenerator' # ReleaseNotes of this module ReleaseNotes = '## [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. ' # Prerelease string of this module Prerelease = 'preview0001' } # End of PSData hashtable } # End of PrivateData hashtable } |