Skip to content

Add-ModuleProperty.md

Latest commit

 

History

History
52 lines (33 loc) · 2.06 KB

Add-ModuleProperty.md

File metadata and controls

52 lines (33 loc) · 2.06 KB

Add-ModuleProperty

Return the value for the given property optionally formatted as a Header.

Parameters

Parameter Set 1

  • [PSObject] HelpDoc A HelpDoc object. Mandatory, ValueFromPipeline
  • [String] Property A top level property from the Help object. Valid values are 'Name', 'Author', 'Description', 'HelpInfoUri', 'LicenseUri', 'ProjectUri', and 'Version'. Mandatory

Parameter Set 2

  • [PSObject] HelpDoc A HelpDoc object. Mandatory, ValueFromPipeline
  • [String] Property A top level property from the Help object. Valid values are 'Name', 'Author', 'Description', 'HelpInfoUri', 'LicenseUri', 'ProjectUri', and 'Version'. Mandatory
  • [Switch] H3 Format the property value as an H3 header.

Parameter Set 3

  • [PSObject] HelpDoc A HelpDoc object. Mandatory, ValueFromPipeline
  • [String] Property A top level property from the Help object. Valid values are 'Name', 'Author', 'Description', 'HelpInfoUri', 'LicenseUri', 'ProjectUri', and 'Version'. Mandatory
  • [Switch] H2 Format the property value as an H2 header.

Parameter Set 4

  • [PSObject] HelpDoc A HelpDoc object. Mandatory, ValueFromPipeline
  • [String] Property A top level property from the Help object. Valid values are 'Name', 'Author', 'Description', 'HelpInfoUri', 'LicenseUri', 'ProjectUri', and 'Version'. Mandatory
  • [Switch] H1 Format the property value as an H1 header.

Examples

Example 1

Get-HelpModuleData build-docs | New-HelpDoc | Add-ModuleProperty -Property Name -H1
Name                           Value
----                           -----
Text                           # build-docs…
PSTypeName                     HelpModuleReadme
HelpModuleData                 @{Name=build-docs; Commands=System.Object[]; Author=System.Object[]; Description=System.Object[]; …

Links

Notes

If no Header switch is provided, the default is no formatting.