| external help file | Module Name | online version | schema |
|---|---|---|---|
PSDocs-help.xml |
PSDocs |
2.0.0 |
Get document definitions.
Get-PSDocument [-Module <String[]>] [-ListAvailable] [-Name <String[]>] [[-Path] <String[]>]
[-Option <PSDocumentOption>] [<CommonParameters>]
Gets a list of document definitions from paths and modules.
Document definitions are discovered within files ending in .Doc.ps1.
By default, definitions will be be discovered from the current working path.
Use -Module to discover definitions from modules.
A document is defined using the Document keyword.
Get-PSDocument;Get a list of document definitions from the current working path.
List document definitions in the specified modules.
When specified, only document definitions from modules will be listed.
To additionally list document definitions in paths use -Path together with -Module.
Type: String[]
Parameter Sets: (All)
Aliases: m
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseGet document definitions from all modules even ones that are not imported.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseA list of paths to check for document definitions.
Type: String[]
Parameter Sets: (All)
Aliases: p
Required: False
Position: 1
Default value: $PWD
Accept pipeline input: False
Accept wildcard characters: FalseThe name of specific document definitions to return.
Type: String[]
Parameter Sets: (All)
Aliases: n
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAdditional options that configure PSDocs.
A PSDocumentOption can be created by using the New-PSDocumentOption cmdlet.
Alternatively a hashtable or path to YAML file can be specified with options.
Type: PSDocumentOption
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
An instance of a document definition.