v0.8.0

[v0.8.0]

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
    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).
• New-DscResourceWikiPage
  • Now supports generating wiki documentation for class-based resources
    (issue #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.

v0.8.0-preview0001

[v0.8.0-preview0001]

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
    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).
• New-DscResourceWikiPage
  • Now supports generating wiki documentation for class-based resources
    (issue #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.

v0.7.4

[v0.7.4]

Fixed

• Conceptual help for MOF-based resource works again (broken in v0.7.3)
  (issue #55).

v0.7.4-preview0001

[v0.7.4-preview0001]

Fixed

• Conceptual help for MOF-based resource works again (broken in v0.7.3)
  (issue #55).

v0.7.3

[v0.7.3]

Added

• Support conceptual help for class-based resources (issue #51).

Changed

• Renamed default branch to main (issue #49).

v0.7.3-preview0002

[v0.7.3-preview0002]

Added

• Support conceptual help for class-based resources (issue #51).

Changed

• Renamed default branch to main (issue #49).

v0.7.3-preview0001

[v0.7.3-preview0001]

Changed

• Renamed default branch to main (issue #49).

v0.7.2

[v0.7.2]

Fixed

• New-WikiFooter
  • Fixed Encoding, parameter value passed to Out-File to use ascii rather
    than [System.Text.Encoding]::ASCII (issue #45).
• New-WikiSidebar
  • Fixed Encoding, parameter value passed to Out-File to use ascii rather
    than [System.Text.Encoding]::ASCII (issue #45).
• Set-WikiModuleVersion
  • Fixed Encoding, parameter value passed to Out-File to use ascii rather
    than [System.Text.Encoding]::ASCII (issue #45).
• Fix the tests for the tasks that recently started failing. The tests
  tried to dot-source the task scripts but that is not possible because
  they need to be run within the scope of Invoke-Build. Instead a new
  test was added to make sure the task alias is pointing to an existing
  task script.

v0.7.2-preview0001

[v0.7.2-preview0001]

Fixed

• Fix the tests for the tasks that recently started failing. The tests
  tried to dot-source the task scripts but that is not possible because
  they need to be run within the scope of Invoke-Build. Instead a new
  test was added to make sure the task alias is pointing to an existing
  task script.

v0.7.1

[v0.7.1]

Fixed

• New-DscResourcePowerShellHelp
  • Fixed so the cmdlet is case-insensitive when it looks for the README.md
    file in a resource source folder (issue #42).