@" $moduleName Documentation

$moduleName

'@ $progress = 0 $commandsHelp | % { Update-Progress $_.Name 'Documentation' $progress++ @"
"@ if (!($_.alias.Length -eq 0)) { @"

$($_.Name) Aliases

    "@ $_.alias | % { @"
  • $($_.Name)
  • "@ } @"
"@ } if (!($_.syntax | Out-String ).Trim().Contains('syntaxItem')) { @"

Syntax

$(FixString($_.syntax | out-string))
"@ } if($_.parameters){ @"

Parameters

"@ $_.parameters.parameter | % { @" "@ } @"
Name Alias Description Required? Pipeline Input Default Value
-$(FixString($_.Name)) $(FixString($_.Aliases)) $(FixString(($_.Description | out-string).Trim()) $true) $(FixString($_.Required)) $(FixString($_.PipelineInput)) $(FixString($_.DefaultValue))
"@ } $inputTypes = $(FixString($_.inputTypes | out-string)) if ($inputTypes.Length -gt 0 -and -not $inputTypes.Contains('inputType')) { @"

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • $inputTypes
"@ } $returnValues = $(FixString($_.returnValues | out-string)) if ($returnValues.Length -gt 0 -and -not $returnValues.StartsWith("returnValue")) { @"

Outputs

The output type is the type of the objects that the cmdlet emits.

  • $returnValues
"@ } $notes = $(FixString($_.alertSet | out-string)) if ($notes.Trim().Length -gt 0) { @"

Note

$notes
"@ } if(($_.examples | Out-String).Trim().Length -gt 0) { @"

Examples

"@ $_.examples.example | % { @" $(FixString($_.title.Trim(('-',' '))))
$(FixString($_.code | out-string ).Trim())
$(FixString($_.remarks | out-string ).Trim())
"@ } @"

Top of page "@ } if(($_.relatedLinks | Out-String).Trim().Length -gt 0) { @"

Links

"@ } @"
"@ } @'
'@