UNPKG

@autorest/powershell

Version:

AutoRest PowerShell Cmdlet Generator

github.com/Azure/autorest.powershell

Azure/autorest.powershell

11 lines (9 loc) • 1.2 kB
1
2
3
4
5
6
7
8
9
10
11
# Docs This directory contains the documentation of the cmdlets for the `${$project.moduleName}` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `${$lib.path.relative($project.docsFolder, $project.examplesFolder)}` folder. ## Info - Modifiable: no - Generated: all - Committed: yes - Packaged: yes ## Details The process of documentation generation loads `${$project.moduleName}` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `${$lib.path.relative($project.docsFolder, $project.exportsFolder)}` folder. Additionally, when writing custom cmdlets in the `${$lib.path.relative($project.docsFolder, $project.customFolder)}` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `${$lib.path.relative($project.docsFolder, $project.examplesFolder)}` folder.