Releases: dsccommunity/DscResource.DocGenerator
Releases · dsccommunity/DscResource.DocGenerator
v0.9.0-preview0007
[v0.9.0-preview0007]
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
orWrite
.Get-CompositeResourceParameterValidateSet
- Returns the array of values
contained in the ValidateSet parameter attributes if it exists.
- Added QA test to do some quality checks on the module code and change log.
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). - Refactored to split into two private functions
New-DscMofResourceWikiPage
and
New-DscClassResourceWikiPage
.
- If a class-based resource has a parent class that contains DSC resource
Get-MofSchemaObject
- Refactored to reduce code duplication when adding functions for supporting
composite resources.
- Refactored to reduce code duplication when adding functions for supporting
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.
- Renamed this function to
- Updated code to pass newly added quality checks.
Invoke-Git
- Converted to public function.
- Updated to use
System.Diagnostics.Process
for improved error handling. - Returns object, allowing caller to process result.
git
commands no longer use--quiet
to populate returned object.
Fixed
v0.9.0-preview0006
[v0.9.0-preview0006]
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
orWrite
.Get-CompositeResourceParameterValidateSet
- Returns the array of values
contained in the ValidateSet parameter attributes if it exists.
- Added QA test to do some quality checks on the module code and change log.
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). - Refactored to split into two private functions
New-DscMofResourceWikiPage
and
New-DscClassResourceWikiPage
.
- If a class-based resource has a parent class that contains DSC resource
Get-MofSchemaObject
- Refactored to reduce code duplication when adding functions for supporting
composite resources.
- Refactored to reduce code duplication when adding functions for supporting
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.
- Renamed this function to
- Updated code to pass newly added quality checks.
Invoke-Git
- Converted to public function.
- Updated to use
System.Diagnostics.Process
for improved error handling. - Returns object, allowing caller to process result.
Fixed
Publish_GitHub_Wiki_Content
- Output message if
$GitHubToken
not specified which skips this task.
Fixes Issue 75
- Output message if
v0.9.0-preview0005
[v0.9.0-preview0005]
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
orWrite
.Get-CompositeResourceParameterValidateSet
- Returns the array of values
contained in the ValidateSet parameter attributes if it exists.
- Added QA test to do some quality checks on the module code and change log.
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). - Refactored to split into two private functions
New-DscMofResourceWikiPage
and
New-DscClassResourceWikiPage
.
- If a class-based resource has a parent class that contains DSC resource
Get-MofSchemaObject
- Refactored to reduce code duplication when adding functions for supporting
composite resources.
- Refactored to reduce code duplication when adding functions for supporting
- Converted
Invoke-Git
cmdlet to useSystem.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.
- Renamed this function to
- Updated code to pass newly added quality checks.
Fixed
Publish_GitHub_Wiki_Content
- Output message if
$GitHubToken
not specified which skips this task.
Fixes Issue 75
- Output message if
v0.9.0-preview0004
[v0.9.0-preview0004]
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
orWrite
.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). - Refactored to split into two private functions
New-DscMofResourceWikiPage
and
New-DscClassResourceWikiPage
.
- If a class-based resource has a parent class that contains DSC resource
Get-MofSchemaObject
- Refactored to reduce code duplication when adding functions for supporting
composite resources.
- Refactored to reduce code duplication when adding functions for supporting
- Converted
Invoke-Git
cmdlet to useSystem.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.
- Renamed this function to
Fixed
Publish_GitHub_Wiki_Content
- Output message if
$GitHubToken
not specified which skips this task.
Fixes Issue 75
- Output message if
v0.9.0-preview0003
[v0.9.0-preview0003]
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). - Refactored to split into two private functions
New-DscMofResourceWikiPage
and
New-DscClassResourceWikiPage
.
- If a class-based resource has a parent class that contains DSC resource
Get-MofSchemaObject
- Refactored to reduce code duplication when adding functions for supporting
composite resources.
- Refactored to reduce code duplication when adding functions for supporting
- Converted
Invoke-Git
cmdlet to useSystem.Diagnostics.Process
for improved error handling.
Fixed
Publish_GitHub_Wiki_Content
- Output message if
$GitHubToken
not specified which skips this task.
Fixes Issue 75
- Output message if
v0.9.0-preview0002
[v0.9.0-preview0002]
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). - Refactored to split into two private functions
New-DscMofResourceWikiPage
and
New-DscClassResourceWikiPage
.
- If a class-based resource has a parent class that contains DSC resource
Get-MofSchemaObject
- Refactored to reduce code duplication when adding functions for supporting
composite resources.
- Refactored to reduce code duplication when adding functions for supporting
Fixed
Publish_GitHub_Wiki_Content
- Output message if
$GitHubToken
not specified which skips this task.
Fixes Issue 75
- Output message if
v0.9.0-preview0001
[v0.9.0-preview0001]
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.
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).
- If a class-based resource has a parent class that contains DSC resource
Fixed
Publish_GitHub_Wiki_Content
- Output message if
$GitHubToken
not specified which skips this task.
Fixes Issue 75
- Output message if
v0.8.4-preview0001
[v0.8.4-preview0001]
Fixed
Publish_GitHub_Wiki_Content
- Output message if
$GitHubToken
not specified which skips this task.
Fixes Issue 75
- Output message if
v0.8.3
v0.8.2-preview0002
[v0.8.2-preview0002]
Added
- DscResource.DocGenerator
- Adding uploading coverage to Codecov.io.
Fixed
- DscResource.DocGenerator
- Fixed formatting in the code through out.
- Minor change in code comment.