Post

Mon Jan 13, 2020 7:29 pm

NAME Write-ModuleHelpDocs

SYNOPSIS

Writes help docs for a given powershell module.

SYNTAX

Write-ModuleHelpDocs [[-Path] <String>] [-Do <ScriptBlock>] [-PostProcess <ScriptBlock>] [-PublishedAt <String>]

[-BaseUri <String>] [<CommonParameters>]

DESCRIPTION

Writes help docs for a given powershell module in

dfx flavored markdown.

PARAMETERS

-Path <String>

Optional. The output directory. Aliases: -Dest,-Destination,-O

Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false

-Do <ScriptBlock>

Optional. Do is an action that overrides the default behavior for

`Write-CmdletDoc`. The default Do action is a pipeline of functions

that are passed a model. The Do action can be used to override

item templates for each part generating help docs.

Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-PostProcess <ScriptBlock>

Optional. A script block with the parameters of for the

file that is generated and the associated PowerShell help

meta data so that a generate file can be processed after

it is generated.

Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-PublishedAt <String>

Optional. Generates and inserts the published at date for

all the generated help documents.

Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

-BaseUri <String>

Optional. Sets the base uri for the documents when the

help doc module is bundled under a larger site.

Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

-------------------------- EXAMPLE 1 --------------------------

PS C:\\>Write-Help -Module "PsReadline" -O "$Home/Desktop/PsReadline"

RELATED LINKS

CommonParameters : False

WorkflowCommonParameters : False

details : @{name=Read-HelpExample; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Read-HelpExample [[-Example] <psobject>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Read-HelpExample

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Read-ModuleHelp; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Read-ModuleHelp [-Module] <string> [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Read-ModuleHelp

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletAlias; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletAlias [[-Model] <psobject>] [[-HeaderTemplate] <string>] [[-ItemTemplate]

<string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletAlias

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletDescription; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletDescription [[-Model] <psobject>] [[-Template] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletDescription

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletDoc; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletDoc [[-Model] <psobject>] [[-Do] <scriptblock>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletDoc

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletExample; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletExample [[-Model] <psobject>] [[-HeaderTemplate] <string>] [[-ItemTemplate]

<string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletExample

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletFrontMatter; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletFrontMatter [[-Model] <psobject>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletFrontMatter

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletInput; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletInput [[-Model] <psobject>] [[-Template] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletInput

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletLink; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletLink [[-Model] <psobject>] [[-HeaderTemplate] <string>] [[-ItemTemplate]

<string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletLink

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletName; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletName [[-Model] <psobject>] [[-Template] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletName

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletNote; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletNote [[-Model] <psobject>] [[-Template] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletNote

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletOutput; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletOutput [[-Model] <psobject>] [[-Template] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletOutput

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletParameter; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletParameter [[-Model] <psobject>] [[-Template] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletParameter

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletSynopsis; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletSynopsis [[-Model] <psobject>] [[-Template] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletSynopsis

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-CmdletSyntax; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-CmdletSyntax [[-Model] <psobject>] [[-Template] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-CmdletSyntax

Category : Function

Component :

Role :

Functionality :

CommonParameters : True

WorkflowCommonParameters : False

details : @{name=Write-EscapedMarkdownString; noun=; verb=}

Syntax : @{syntaxItem=System.Object[]}

parameters : @{parameter=System.Object[]}

inputTypes : @{inputType=}

returnValues : @{returnValue=}

aliases : None

remarks : None

alertSet :

description :

examples :

Synopsis :

Write-EscapedMarkdownString [[-Value] <string>] [<CommonParameters>]

ModuleName : Fmg-HelpDocs

nonTerminatingErrors :

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

Name : Write-EscapedMarkdownString

Category : Function

Component :

Role :

Functionality :

Post a reply in the forum

Write-ModuleHelpDocs

Share this page: