en-US/PowerBolt-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-ModuleToProfile</command:name> <command:verb>Add</command:verb> <command:noun>ModuleToProfile</command:noun> <maml:description> <maml:para>Appends content of the PowerShell session's profile with an `Import-Module` statement.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Appends content of `$PROFILE` file (or content of `ProfilePath` parameter if is used) with an `Import-Module` statement that imports the module found with `Path`.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-ModuleToProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path to module folder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ProfilePath</maml:name> <maml:Description> <maml:para>`$PROFILE` is default profile value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$(Get-Variable Profile -ValueOnly)</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path to module folder.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ProfilePath</maml:name> <maml:Description> <maml:para>`$PROFILE` is default profile value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$(Get-Variable Profile -ValueOnly)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-Content $PROFILE Import-Module C:\Users\Alice\Documents\PowerShell\Modules\posh-git\0.7.1\posh-git.psd1 PS C:\> Add-ModuleToProfile -Path C:\Users\Alice\PowerSploit PS C:\> Get-Content $PROFILE Import-Module C:\Users\Alice\Documents\PowerShell\Modules\posh-git\0.7.1\posh-git.psd1 Import-Module C:\Users\Alice\PowerSploit PS C:\></dev:code> <dev:remarks> <maml:para>The module found in PowerSploit folder will have an `Import-Module` statement added to the default profile ($PROFILE) item.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Add-ModuleToProfile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ModuleToProfile.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/profile/Add-ModuleToProfile.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-ModuleToProfile.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/profile/Add-ModuleToProfile.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Skip-ModuleInProfile`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Skip-ModuleInProfile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Reset-ModuleInProfile`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Reset-ModuleInProfile.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Build-Documentation</command:name> <command:verb>Build</command:verb> <command:noun>Documentation</command:noun> <maml:description> <maml:para>Creates or updates help documentation files and module's README file. Also creates a XML based help documentation file for PowerShell.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>With required `PlatyPS` (https://github.com/PowerShell/platyPS) module, this function will generate Markdown help documentation files (such as the file where you are reading this from)and update or create a README.md file with new functions from the help docs. Also this generates a new PowerShell help doc file that is used in the CLI.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Build-Documentation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>If the module is already imported, the value is the name of the module.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Locale</maml:name> <maml:Description> <maml:para>The name of the folder where PowerShell XML file will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>A relative path of module's folder where the Markdown files reside or will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>docs</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoReImportModule</maml:name> <maml:Description> <maml:para>By default this function will re-import module to get the latest changes to that modules source code.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlPolicy</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlPolicy Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Omit</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlTemplate</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlTemplate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Build-Documentation</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Folder that contains a module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Locale</maml:name> <maml:Description> <maml:para>The name of the folder where PowerShell XML file will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>A relative path of module's folder where the Markdown files reside or will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>docs</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoReImportModule</maml:name> <maml:Description> <maml:para>By default this function will re-import module to get the latest changes to that modules source code.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlPolicy</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlPolicy Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Omit</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlTemplate</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlTemplate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Locale</maml:name> <maml:Description> <maml:para>The name of the folder where PowerShell XML file will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>A relative path of module's folder where the Markdown files reside or will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>docs</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>If the module is already imported, the value is the name of the module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoReImportModule</maml:name> <maml:Description> <maml:para>By default this function will re-import module to get the latest changes to that modules source code.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlPolicy</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlPolicy Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlTemplate</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlTemplate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Folder that contains a module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>MKPowerShellDocObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\Users\Alice\PowerSploit> Build-Documentation</dev:code> <dev:remarks> <maml:para>Builds documentation for the PowerSploit module with default parameters.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Build-Documentation.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Build-Documentation.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/documentation/Build-Documentation.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Build-Documentation.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/documentation/Build-Documentation.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Build-PlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Build-PlatyPSMarkdown.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`New-ExternalHelpFromPlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/New-ExternalHelpFromPlatyPSMarkdown.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Update-ReadmeFromPlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-ReadmeFromPlatyPSMarkdown.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Build-PlatyPSMarkdown</command:name> <command:verb>Build</command:verb> <command:noun>PlatyPSMarkdown</command:noun> <maml:description> <maml:para>With required `PlatyPS` (https://github.com/PowerShell/platyPS) module, calls [`New-MarkdownHelp`](https://github.com/PowerShell/platyPS/blob/master/docs/New-MarkdownHelp.md) or [`Update-MarkdownHelpModule`](https://github.com/PowerShell/platyPS/blob/master/docs/Update-MarkdownHelpModule.md).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If no Markdown files are in `MarkdownFolder`, this function will call `New-MarkdownHelp`. Else it will call `Update-MarkdownHelpModule`. After `New-MarkdownHelp` is executed it will iterate thru the newly Markdown files and add the online version url to file. This value, by default, is retrieved from a .git directory (if there is one) of the module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Build-PlatyPSMarkdown</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>DocInfo</maml:name> <maml:Description> <maml:para>{{Fill DocInfo Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MKDocumentationInfo</command:parameterValue> <dev:type> <maml:name>MKDocumentationInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Locale</maml:name> <maml:Description> <maml:para>The name of the folder where PowerShell XML file will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>A relative path of module's folder where the Markdown files reside or will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>docs</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoReImportModule</maml:name> <maml:Description> <maml:para>Prevents re-importing module prior to executing PlatyPS's `New-MarkdownHelp` or `Update-MarkdownHelpModule`.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlPolicy</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlPolicy Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Omit</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlTemplate</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlTemplate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoveSourceAndTestLinks</maml:name> <maml:Description> <maml:para>{{Fill RemoveSourceAndTestLinks Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Build-PlatyPSMarkdown</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>If the module is already imported, the value is the name of the module.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Locale</maml:name> <maml:Description> <maml:para>The name of the folder where PowerShell XML file will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>A relative path of module's folder where the Markdown files reside or will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>docs</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoReImportModule</maml:name> <maml:Description> <maml:para>Prevents re-importing module prior to executing PlatyPS's `New-MarkdownHelp` or `Update-MarkdownHelpModule`.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlPolicy</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlPolicy Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Omit</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlTemplate</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlTemplate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoveSourceAndTestLinks</maml:name> <maml:Description> <maml:para>{{Fill RemoveSourceAndTestLinks Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Build-PlatyPSMarkdown</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Folder that contains a module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Locale</maml:name> <maml:Description> <maml:para>The name of the folder where PowerShell XML file will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>A relative path of module's folder where the Markdown files reside or will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>docs</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoReImportModule</maml:name> <maml:Description> <maml:para>Prevents re-importing module prior to executing PlatyPS's `New-MarkdownHelp` or `Update-MarkdownHelpModule`.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlPolicy</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlPolicy Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Auto</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Omit</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlTemplate</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlTemplate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoveSourceAndTestLinks</maml:name> <maml:Description> <maml:para>{{Fill RemoveSourceAndTestLinks Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>DocInfo</maml:name> <maml:Description> <maml:para>{{Fill DocInfo Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MKDocumentationInfo</command:parameterValue> <dev:type> <maml:name>MKDocumentationInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Locale</maml:name> <maml:Description> <maml:para>The name of the folder where PowerShell XML file will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>en-US</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>A relative path of module's folder where the Markdown files reside or will reside.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>docs</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>If the module is already imported, the value is the name of the module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoReImportModule</maml:name> <maml:Description> <maml:para>Prevents re-importing module prior to executing PlatyPS's `New-MarkdownHelp` or `Update-MarkdownHelpModule`.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlPolicy</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlPolicy Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OnlineVersionUrlTemplate</maml:name> <maml:Description> <maml:para>{{Fill OnlineVersionUrlTemplate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Folder that contains a module.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RemoveSourceAndTestLinks</maml:name> <maml:Description> <maml:para>{{Fill RemoveSourceAndTestLinks Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>MKPowerShellDocObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Build-PlatyPSMarkdown -Path C:\Users\Alice\PowerSploit -NoReImportModule</dev:code> <dev:remarks> <maml:para>With specified `Path` value and `NoReImportModule` switched, this will generate (new or update) files for PowerSploit module. The `NoReImportModule` prevents re-importing PowerSploit so the current state of this imported module is used. In otherwords, if changes to the source code of PowerSploit has been made it will not be available until it is imported again. And because of that `NoReImportModule` is typically not switched.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Build-PlatyPSMarkdown.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Build-PlatyPSMarkdown.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/documentation/Build-PlatyPSMarkdown.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Build-PlatyPSMarkdown.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/documentation/Build-PlatyPSMarkdown.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Build-Documentation`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Build-Documentation.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`New-ExternalHelpFromPlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/New-ExternalHelpFromPlatyPSMarkdown.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Update-ReadmeFromPlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-ReadmeFromPlatyPSMarkdown.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertTo-EnumFlag</command:name> <command:verb>ConvertTo</command:verb> <command:noun>EnumFlag</command:noun> <maml:description> <maml:para>With `InputObject` tested for equality via `-eq`, will `Write-Output` `Value` only when equality operator returns `true`.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-EnumFlag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>{{Fill Value Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Enum</command:parameterValue> <dev:type> <maml:name>Enum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>{{Fill InputObject Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>{{Fill InputObject Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>{{Fill Value Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Enum</command:parameterValue> <dev:type> <maml:name>Enum</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $LifeEvents += (Get-Date) -ge (Get-Date -Year 2061) | ConvertTo-EnumFlag -Value ([CosmicEvents]::WatchHalley)</dev:code> <dev:remarks> <maml:para>The `-ge` assertation will pipe a bool value in `ConvertTo-EnumFlag` which will increment `$LifeEvents` with `[CosmicEvents]::WatchHalley` if the assertation is `true`. If the piped value is `false`, `ConvertTo-EnumFlag` will `Write-Output` with `0`.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/ConvertTo-EnumFlag.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertTo-EnumFlag.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/utility/ConvertTo-EnumFlag.ps1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MergedPath</command:name> <command:verb>Get</command:verb> <command:noun>MergedPath</command:noun> <maml:description> <maml:para>Returns a valid path from a parent of one of its children which overlaps that parent's path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In set-theory this will be considered a relative complement. That is the directories in ChildPath that are not in Path.</maml:para> <maml:para>A diagram to illustrate what is mentioned above: A = C:\Windows\diagnostics\system B = .\diagnostics\system\Keyboard\en-US\CL_LocalizationData.psd1 B\A = .\Keyboard\en-US\CL_LocalizationData.psd1 R = C:\Windows\diagnostics\system\Keyboard\en-US\CL_LocalizationData.psd1</maml:para> <maml:para>The path 'R' is what will be returned if -IsValid is not switched otherwise $true will be returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MergedPath</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Parent path of $ChildPath. This can be relative.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChildPath</maml:name> <maml:Description> <maml:para>Child path of $Path.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsValid</maml:name> <maml:Description> <maml:para>Returns true if function found a complement folder. False is returned if no complement was found.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Parent path of $ChildPath. This can be relative.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ChildPath</maml:name> <maml:Description> <maml:para>Child path of $Path.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsValid</maml:name> <maml:Description> <maml:para>Returns true if function found a complement folder. False is returned if no complement was found.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>E:\Temp\AIT\> Get-MergedPath E:\Temp\AIT\resources\ -ChildPath .\resources\android\AiT-Feature.jpg E:\Temp\AIT\resources\android\AiT-Feature.jpg E:\Temp\AIT\> Get-MergedPath E:\Temp\AIT\resources\ -ChildPath .\resources\android\AiT-Feature.jpg -IsValid True</dev:code> <dev:remarks> <maml:para>Demonstration of using Get-MergedPath with truthly values</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>E:\Temp\AIT\> Get-MergedPath E:\Temp\AIT\resources\ -ChildPath .\reWWWources\android\AiT-Feature.jpg E:\Temp\AIT\> Get-MergedPath E:\Temp\AIT\resources\ -ChildPath .\reWWWources\android\AiT-Feature.jpg -IsValid False</dev:code> <dev:remarks> <maml:para>Demonstration of using Get-MergedPath with falsely values</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Get-MergedPath.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MergedPath.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/utility/Get-MergedPath.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://gist.github.com/marckassay/2f54ae68779c9f27fd130b193374335c</maml:linkText> <maml:uri>https://gist.github.com/marckassay/2f54ae68779c9f27fd130b193374335c</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-MKModuleInfo</command:name> <command:verb>Get</command:verb> <command:noun>MKModuleInfo</command:noun> <maml:description> <maml:para>Outputs information about a module with given name or path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Valid `Path` parameter values are to a manifest (.psd1) file, module (.psm1) file and root module directory. And valid `Name` parameter values are constricted to modules installed locally. With those possible values information about the module with be returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MKModuleInfo</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>A dynamic parameter with its valid set being confined to locally installed modules.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-MKModuleInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Valid values are to a manifest (.psd1) file, module (.psm1) file and root module directory.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>A dynamic parameter with its valid set being confined to locally installed modules.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Valid values are to a manifest (.psd1) file, module (.psm1) file and root module directory.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-MKModuleInfo -Name Plaster Name : Plaster Path : E:\Plaster\Release\Plaster PathFolderName : Plaster ManifestFilePath : E:\Plaster\Release\Plaster\Plaster.psd1 RootModuleFilePath : E:\Plaster\Release\Plaster\Plaster.psm1 Version : 1.1.4</dev:code> <dev:remarks> <maml:para>With Plaster being installed locally, it is valid value in the parameter set.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Get-MKModuleInfo.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MKModuleInfo.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/module/Get-MKModuleInfo.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MKModuleInfo.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/module/Get-MKModuleInfo.Tests.ps1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-PowerBoltSetting</command:name> <command:verb>Get</command:verb> <command:noun>PowerBoltSetting</command:noun> <maml:description> <maml:para>Retrieves JSON data from `PowerBolt-config.json` or outputs file via `ShowAll` switch.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PowerBoltSetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">NuGetApiKey</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TurnOnAutoUpdateSemVer</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ConfigFilePath</maml:name> <maml:Description> <maml:para>{{Fill ConfigFilePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ConfigFilePath</maml:name> <maml:Description> <maml:para>{{Fill ConfigFilePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Get-PowerBoltSetting.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PowerBoltSetting.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/settings/Get-PowerBoltSetting.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-PowerBoltSetting.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/settings/Get-PowerBoltSetting.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Set-PowerBoltSetting`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Set-PowerBoltSetting.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-Template</command:name> <command:verb>Install</command:verb> <command:noun>Template</command:noun> <maml:description> <maml:para>Scaffolds files based on the required Plaster (https://github.com/PowerShell/Plaster)template.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>When `PlasterTemplatePath` is set to a Plaster template, this script will inspect the template for variables that will become additional parameters. Those variables must be in the form of the Plaster style variables. For an example: 'PLASTER_PARAM_CongruentPath', where 'CongruentPath' is the variable that will appear as an additional parameter.</maml:para> <maml:para>If calling this method by script and not thru the CLI, positional binding is enabled so that can be done.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-Template</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TemplatePath</maml:name> <maml:Description> <maml:para>A path value to a Plaster template (manifest) file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ScriptCongruentPath</maml:name> <maml:Description> <maml:para>{{Fill ScriptCongruentPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ScriptName</maml:name> <maml:Description> <maml:para>{{Fill ScriptName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Install-Template</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TemplateName</maml:name> <maml:Description> <maml:para>{{Fill TemplateName Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">NewScript</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NewModuleProject</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ScriptCongruentPath</maml:name> <maml:Description> <maml:para>{{Fill ScriptCongruentPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ScriptName</maml:name> <maml:Description> <maml:para>{{Fill ScriptName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TemplateName</maml:name> <maml:Description> <maml:para>{{Fill TemplateName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TemplatePath</maml:name> <maml:Description> <maml:para>A path value to a Plaster template (manifest) file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Install-Template -PlasterTemplatePath 'C:\Users\Alice\PlasterTemplates\NewMVC\plasterManifest_en-US.xml' -AppName 'CoffeeApp'</dev:code> <dev:remarks> <maml:para>One can deduce that the variable 'PLASTER_PARAM_AppName' is in the template file, which is used in this example to assign a name value to the app being scaffold.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Install-Template.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-Template.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/scaffolds/Install-Template.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-Template.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/scaffolds/Install-Template.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Plaster - Creating A Manifest</maml:linkText> <maml:uri>https://github.com/PowerShell/Plaster/blob/master/docs/en-US/about_Plaster_CreatingAManifest.help.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-TestSuiteRunner</command:name> <command:verb>Invoke</command:verb> <command:noun>TestSuiteRunner</command:noun> <maml:description> <maml:para>Creates a PowerShell background job that calls `Invoke-Pester` (https://github.com/pester/Pester/wiki/Invoke-Pester)</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-TestSuiteRunner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TestFolderPath</maml:name> <maml:Description> <maml:para>{{Fill TestFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Show</maml:name> <maml:Description> <maml:para>{{Fill Show Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Passed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Failed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Skipped</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inconclusive</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Describe</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Context</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Summary</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Header</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fails</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputTypes[]</command:parameterValue> <dev:type> <maml:name>OutputTypes[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-TestSuiteRunner</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TestFolderPath</maml:name> <maml:Description> <maml:para>{{Fill TestFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Show</maml:name> <maml:Description> <maml:para>{{Fill Show Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Passed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Failed</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Skipped</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Inconclusive</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Describe</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Context</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Summary</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Header</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fails</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">OutputTypes[]</command:parameterValue> <dev:type> <maml:name>OutputTypes[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Show</maml:name> <maml:Description> <maml:para>{{Fill Show Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">OutputTypes[]</command:parameterValue> <dev:type> <maml:name>OutputTypes[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TestFolderPath</maml:name> <maml:Description> <maml:para>{{Fill TestFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Invoke-TestSuiteRunner -Name PowerSploit</dev:code> <dev:remarks> <maml:para>Using the `ByName` validation parameter set and since no `TestFolderPath` value has been assigned, it will use the relative path of `test`</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Invoke-TestSuiteRunner.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-TestSuiteRunner.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/test/Invoke-TestSuiteRunner.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-TestSuiteRunner.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/test/Invoke-TestSuiteRunner.Tests.ps1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ExternalHelpFromPlatyPSMarkdown</command:name> <command:verb>New</command:verb> <command:noun>ExternalHelpFromPlatyPSMarkdown</command:noun> <maml:description> <maml:para>Calls `New-ExternalHelp` from `PlatyPS` module. This functions will read the files in the folder from `Build-PlatyPSMarkdown`.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ExternalHelpFromPlatyPSMarkdown</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>DocInfo</maml:name> <maml:Description> <maml:para>{{Fill DocInfo Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MKDocumentationInfo</command:parameterValue> <dev:type> <maml:name>MKDocumentationInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>{{Fill MarkdownFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFolder</maml:name> <maml:Description> <maml:para>{{Fill OutputFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-ExternalHelpFromPlatyPSMarkdown</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>{{Fill MarkdownFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFolder</maml:name> <maml:Description> <maml:para>{{Fill OutputFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-ExternalHelpFromPlatyPSMarkdown</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>{{Fill MarkdownFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFolder</maml:name> <maml:Description> <maml:para>{{Fill OutputFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>DocInfo</maml:name> <maml:Description> <maml:para>{{Fill DocInfo Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MKDocumentationInfo</command:parameterValue> <dev:type> <maml:name>MKDocumentationInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>{{Fill MarkdownFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFolder</maml:name> <maml:Description> <maml:para>{{Fill OutputFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>MKPowerShellDocObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/New-ExternalHelpFromPlatyPSMarkdown.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-ExternalHelpFromPlatyPSMarkdown.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/documentation/New-ExternalHelpFromPlatyPSMarkdown.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-ExternalHelpFromPlatyPSMarkdown.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/documentation/New-ExternalHelpFromPlatyPSMarkdown.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Build-Documentation`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Build-Documentation.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Build-PlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Build-PlatyPSMarkdown.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Update-ReadmeFromPlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-ReadmeFromPlatyPSMarkdown.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-PowerBoltConfigFile</command:name> <command:verb>New</command:verb> <command:noun>PowerBoltConfigFile</command:noun> <maml:description> <maml:para>Creates a new `PowerBolt-config.json` to be used for settings for `PowerBolt`.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-PowerBoltConfigFile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>{{Fill Force Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/New-PowerBoltConfigFile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PowerBoltConfigFile.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/settings/New-PowerBoltConfigFile.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-PowerBoltConfigFile.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/settings/New-PowerBoltConfigFile.Tests.ps1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Publish-ModuleToNuGetGallery</command:name> <command:verb>Publish</command:verb> <command:noun>ModuleToNuGetGallery</command:noun> <maml:description> <maml:para>Streamlines publishing a module using `Publish-Module`.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>When `PowerBolt-config.json` has valid `NuGetApiKey`, it will deploy locally module to a temp folder, removing specified items via `Exclude`, prompt user to confirm publishing and will "teardown" setup items after confirming.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-ModuleToNuGetGallery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DoNotConfirm</maml:name> <maml:Description> <maml:para>{{Fill DoNotConfirm Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NuGetApiKey</maml:name> <maml:Description> <maml:para>{{Fill NuGetApiKey Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-ModuleToNuGetGallery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DoNotConfirm</maml:name> <maml:Description> <maml:para>{{Fill DoNotConfirm Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NuGetApiKey</maml:name> <maml:Description> <maml:para>{{Fill NuGetApiKey Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DoNotConfirm</maml:name> <maml:Description> <maml:para>{{Fill DoNotConfirm Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NuGetApiKey</maml:name> <maml:Description> <maml:para>{{Fill NuGetApiKey Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Publish-ModuleToNuGetGallery.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-ModuleToNuGetGallery.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/publish/Publish-ModuleToNuGetGallery.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-ModuleToNuGetGallery.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/publish/Publish-ModuleToNuGetGallery.Tests.ps1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-ModuleInProfile</command:name> <command:verb>Reset</command:verb> <command:noun>ModuleInProfile</command:noun> <maml:description> <maml:para>Re-enables an `Import-Module` statement in `$PROFILE` to be executed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>With `Name` param being a dynamic valid set of module names in `$PROFILE`, when called with one of these names it will uncomment (remove the prefix `#`) from the Import-Module statement for that module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-ModuleInProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">PowerShellGet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ProfilePath</maml:name> <maml:Description> <maml:para>{{Fill ProfilePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ProfilePath</maml:name> <maml:Description> <maml:para>{{Fill ProfilePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Reset-ModuleInProfile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-ModuleInProfile.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/profile/Reset-ModuleInProfile.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Reset-ModuleInProfile.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/profile/Reset-ModuleInProfile.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Add-ModuleToProfile`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Add-ModuleToProfile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Skip-ModuleInProfile`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Skip-ModuleInProfile.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Search-Items</command:name> <command:verb>Search</command:verb> <command:noun>Items</command:noun> <maml:description> <maml:para>Recurses thru folders to find files that its content matches `Pattern`. Outputs object(s) to console.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Search-Items</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Pattern</maml:name> <maml:Description> <maml:para>{{Fill Pattern Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Depth</maml:name> <maml:Description> <maml:para>{{Fill Depth Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:Description> <maml:para>{{Fill Recurse Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Depth</maml:name> <maml:Description> <maml:para>{{Fill Depth Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Pattern</maml:name> <maml:Description> <maml:para>{{Fill Pattern Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:Description> <maml:para>{{Fill Recurse Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Search-Items -Path C:\Users\Alice\PowerBolt -Pattern '.*TODO.*' -Recurse Name Value ---- ----- Item ConvertTo-EnumFlag.ps1 Match # TODO: look into EnumConverter to see if it can be used here MatchedLine # TODO: look into EnumConverter to see if it can be used here Item MKPowerShellDocObject.psm1 Match # TODO: need to have this functions arity better fitted for options MatchedLine # TODO: need to have this functions arity better fitted for options ...</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Search-Items.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Search-Items.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/utility/Search-Items.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Search-Items.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/utility/Search-Items.Tests.ps1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-PowerBoltSetting</command:name> <command:verb>Set</command:verb> <command:noun>PowerBoltSetting</command:noun> <maml:description> <maml:para>Sets value to JSON data in `PowerBolt-config.json`.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-PowerBoltSetting</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">NuGetApiKey</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TurnOnAutoUpdateSemVer</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>{{Fill Value Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ConfigFilePath</maml:name> <maml:Description> <maml:para>{{Fill ConfigFilePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ConfigFilePath</maml:name> <maml:Description> <maml:para>{{Fill ConfigFilePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>{{Fill Value Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Set-PowerBoltSetting.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PowerBoltSetting.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/settings/Set-PowerBoltSetting.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-PowerBoltSetting.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/settings/Set-PowerBoltSetting.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Get-PowerBoltSetting`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Get-PowerBoltSetting.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Skip-ModuleInProfile</command:name> <command:verb>Skip</command:verb> <command:noun>ModuleInProfile</command:noun> <maml:description> <maml:para>Prevents an `Import-Module` statement in `$PROFILE` from executing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>With `Name` param being a dynamic valid set of module names in `$PROFILE`, when called with one of these names it will comment (`#`) the Import-Module statement for that module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Skip-ModuleInProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">posh-git.psd1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ProfilePath</maml:name> <maml:Description> <maml:para>{{Fill ProfilePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ProfilePath</maml:name> <maml:Description> <maml:para>{{Fill ProfilePath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Skip-ModuleInProfile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Skip-ModuleInProfile.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/profile/Skip-ModuleInProfile.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Skip-ModuleInProfile.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/profile/Skip-ModuleInProfile.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Add-ModuleToProfile`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Add-ModuleToProfile.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Reset-ModuleInProfile`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Reset-ModuleInProfile.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-ManifestFunctionsToExportField</command:name> <command:verb>Update</command:verb> <command:noun>ManifestFunctionsToExportField</command:noun> <maml:description> <maml:para>Ideally having `Update-RootModuleUsingStatements` piped into this function, it will popluate a string array of function names and set it to the `FunctionsToExport`.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-ManifestFunctionsToExportField</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>ManifestUpdate</maml:name> <maml:Description> <maml:para>{{Fill ManifestUpdate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>ManifestUpdate</maml:name> <maml:Description> <maml:para>{{Fill ManifestUpdate Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSModuleInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-ManifestFunctionsToExportField.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ManifestFunctionsToExportField.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/module/manifest/Update-ManifestFunctionsToExportField.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ManifestFunctionsToExportField.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/module/manifest/Update-ManifestFunctionsToExportField.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Update-RootModuleUsingStatements`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-RootModuleUsingStatements.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-ModuleExports</command:name> <command:verb>Update</command:verb> <command:noun>ModuleExports</command:noun> <maml:description> <maml:para>Updates root-module and manifest file with commands to be exported.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>When called, it will search for .ps1 files in the `SourceDirectory` and update the root module with `using module` statements with the files it has found. If anywhere in the file a `# NoExport: <Command>` comment is found, it will omit that command from being listed in the manifest file. Also all commands that are intended to be exported must follow the PowerShell convention of `<verb>-<noun>`.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-ModuleExports</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-ModuleExports</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-ModuleExports.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ModuleExports.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/module/Update-ModuleExports.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ModuleExports.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/module/Update-ModuleExports.Tests.ps1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-ReadmeFromPlatyPSMarkdown</command:name> <command:verb>Update</command:verb> <command:noun>ReadmeFromPlatyPSMarkdown</command:noun> <maml:description> <maml:para>Adds or updates function's 'snippet' in README file from `PlatyPS` generated files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-ReadmeFromPlatyPSMarkdown</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>DocInfo</maml:name> <maml:Description> <maml:para>{{Fill DocInfo Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MKDocumentationInfo</command:parameterValue> <dev:type> <maml:name>MKDocumentationInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>{{Fill FileName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>{{Fill MarkdownFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-ReadmeFromPlatyPSMarkdown</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>{{Fill FileName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>{{Fill MarkdownFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-ReadmeFromPlatyPSMarkdown</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>{{Fill FileName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>{{Fill MarkdownFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>DocInfo</maml:name> <maml:Description> <maml:para>{{Fill DocInfo Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MKDocumentationInfo</command:parameterValue> <dev:type> <maml:name>MKDocumentationInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileName</maml:name> <maml:Description> <maml:para>{{Fill FileName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MarkdownFolder</maml:name> <maml:Description> <maml:para>{{Fill MarkdownFolder Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>MKPowerShellDocObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-ReadmeFromPlatyPSMarkdown.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ReadmeFromPlatyPSMarkdown.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/documentation/Update-ReadmeFromPlatyPSMarkdown.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-ReadmeFromPlatyPSMarkdown.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/documentation/Update-ReadmeFromPlatyPSMarkdown.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Build-Documentation`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Build-Documentation.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Build-PlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Build-PlatyPSMarkdown.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`New-ExternalHelpFromPlatyPSMarkdown`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/New-ExternalHelpFromPlatyPSMarkdown.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-RootModuleUsingStatements</command:name> <command:verb>Update</command:verb> <command:noun>RootModuleUsingStatements</command:noun> <maml:description> <maml:para>Prepends module found in `Path` with `using module ...` statements. Those statements are unique PS1 file paths that contain functions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{Fill in the Description}}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-RootModuleUsingStatements</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>ModInfo</maml:name> <maml:Description> <maml:para>{{Fill ModInfo Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MKModuleInfo</command:parameterValue> <dev:type> <maml:name>MKModuleInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-RootModuleUsingStatements</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-RootModuleUsingStatements</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:Description> <maml:para>{{Fill Exclude Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Include</maml:name> <maml:Description> <maml:para>{{Fill Include Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>ModInfo</maml:name> <maml:Description> <maml:para>{{Fill ModInfo Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MKModuleInfo</command:parameterValue> <dev:type> <maml:name>MKModuleInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>{{Fill PassThru Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-RootModuleUsingStatements.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RootModuleUsingStatements.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/module/Update-RootModuleUsingStatements.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-RootModuleUsingStatements.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/module/Update-RootModuleUsingStatements.Tests.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>`Update-ManifestFunctionsToExportField`</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-ManifestFunctionsToExportField.md</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-SemVer</command:name> <command:verb>Update</command:verb> <command:noun>SemVer</command:noun> <maml:description> <maml:para>Updates the module's semantic version value in the manifest file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>With given values by Path or Name, it will change the ModuleVersion key in the module's manifest file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-SemVer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Major</maml:name> <maml:Description> <maml:para>{{Fill Major Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Minor</maml:name> <maml:Description> <maml:para>{{Fill Minor Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Patch</maml:name> <maml:Description> <maml:para>{{Fill Patch Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoUpdate</maml:name> <maml:Description> <maml:para>{{Fill AutoUpdate Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpMajor</maml:name> <maml:Description> <maml:para>{{Fill BumpMajor Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpMinor</maml:name> <maml:Description> <maml:para>{{Fill BumpMinor Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpPatch</maml:name> <maml:Description> <maml:para>{{Fill BumpPatch Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>{{Fill Value Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SemVer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">CimCmdlets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Management</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Microsoft.PowerShell.Utility</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Pester</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plaster</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">platyPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">posh-git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PowerBolt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PSReadLine</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Major</maml:name> <maml:Description> <maml:para>{{Fill Major Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Minor</maml:name> <maml:Description> <maml:para>{{Fill Minor Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Patch</maml:name> <maml:Description> <maml:para>{{Fill Patch Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoUpdate</maml:name> <maml:Description> <maml:para>{{Fill AutoUpdate Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpMajor</maml:name> <maml:Description> <maml:para>{{Fill BumpMajor Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpMinor</maml:name> <maml:Description> <maml:para>{{Fill BumpMinor Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpPatch</maml:name> <maml:Description> <maml:para>{{Fill BumpPatch Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>{{Fill Value Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SemVer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoUpdate</maml:name> <maml:Description> <maml:para>{{Fill AutoUpdate Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SemVer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpMajor</maml:name> <maml:Description> <maml:para>{{Fill BumpMajor Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpMinor</maml:name> <maml:Description> <maml:para>{{Fill BumpMinor Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpPatch</maml:name> <maml:Description> <maml:para>{{Fill BumpPatch Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SemVer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Major</maml:name> <maml:Description> <maml:para>{{Fill Major Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Minor</maml:name> <maml:Description> <maml:para>{{Fill Minor Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Patch</maml:name> <maml:Description> <maml:para>{{Fill Patch Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SemVer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>{{Fill Value Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AutoUpdate</maml:name> <maml:Description> <maml:para>{{Fill AutoUpdate Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpMajor</maml:name> <maml:Description> <maml:para>{{Fill BumpMajor Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpMinor</maml:name> <maml:Description> <maml:para>{{Fill BumpMinor Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BumpPatch</maml:name> <maml:Description> <maml:para>{{Fill BumpPatch Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Major</maml:name> <maml:Description> <maml:para>{{Fill Major Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Minor</maml:name> <maml:Description> <maml:para>{{Fill Minor Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>{{Fill Name Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Patch</maml:name> <maml:Description> <maml:para>{{Fill Patch Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>{{Fill Path Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SourceFolderPath</maml:name> <maml:Description> <maml:para>{{Fill SourceFolderPath Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>{{Fill Value Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/docs/Update-SemVer.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-SemVer.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/src/module/manifest/Update-SemVer.ps1</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-SemVer.Tests.ps1</maml:linkText> <maml:uri>https://github.com/marckassay/PowerBolt/blob/0.0.4/test/module/manifest/Update-SemVer.Tests.ps1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |