Edit‑CommandDocumentation

SYNOPSIS

Edits the documentation for a command by parsing the comment-based help from the source file.

SYNTAX

Edit-CommandDocumentation [-FilePath] <FileInfo> [<CommonParameters>]

DESCRIPTION

Edits the documentation for a command by parsing the comment-based help from the source file.

EXAMPLES

EXAMPLE 1

$filePath = Get-Item -Path 'C:\Docs\MyCommand.md'
Edit-CommandDocumentation -FilePath $filePath -SourcePath 'C:\Scripts\MyCommand.ps1'

Edits the documentation for the command specified in the markdown file "C:\Docs\MyCommand.md" using the source file "C:\Scripts\MyCommand.ps1".

PARAMETERS

-FilePath

Specifies the FileInfo object of the markdown file containing the documentation being edited. This parameter is mandatory.

Type: FileInfo
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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.

INPUTS

OUTPUTS

NOTES

RELATED LINKS