diff --git a/docs/Update-MarkdownHelpModule.md b/docs/Update-MarkdownHelpModule.md index b29c267e..b2f01063 100644 --- a/docs/Update-MarkdownHelpModule.md +++ b/docs/Update-MarkdownHelpModule.md @@ -14,7 +14,8 @@ Update all files in a markdown help module folder. ``` Update-MarkdownHelpModule [-Path] [[-Encoding] ] [-RefreshModulePage] - [[-LogPath] ] [-LogAppend] [-AlphabeticParamsOrder] [-Session ] [] + [[-LogPath] ] [-LogAppend] [-AlphabeticParamsOrder] [-UseFullTypeName] [-Session ] + [] ``` ## DESCRIPTION @@ -167,6 +168,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UseFullTypeName +Indicates that the target document will use a full type name instead of a short name for parameters. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/platyPS/platyPS.psm1 b/src/platyPS/platyPS.psm1 index ac4c76be..d35df083 100644 --- a/src/platyPS/platyPS.psm1 +++ b/src/platyPS/platyPS.psm1 @@ -561,6 +561,7 @@ function Update-MarkdownHelpModule [string]$LogPath, [switch]$LogAppend, [switch]$AlphabeticParamsOrder, + [switch]$UseFullTypeName, [System.Management.Automation.Runspaces.PSSession]$Session ) @@ -615,7 +616,7 @@ function Update-MarkdownHelpModule # always append on this call log ("[Update-MarkdownHelpModule]" + (Get-Date).ToString()) log ("Updating docs for Module " + $module + " in " + $modulePath) - $affectedFiles = Update-MarkdownHelp -Session $Session -Path $modulePath -LogPath $LogPath -LogAppend -Encoding $Encoding -AlphabeticParamsOrder:$AlphabeticParamsOrder + $affectedFiles = Update-MarkdownHelp -Session $Session -Path $modulePath -LogPath $LogPath -LogAppend -Encoding $Encoding -AlphabeticParamsOrder:$AlphabeticParamsOrder -UseFullTypeName:$UseFullTypeName $affectedFiles # yeild $allCommands = GetCommands -AsNames -Module $Module