RemoveModuleManifestComments-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>Remove-ModuleManifestComments</command:name> <command:verb>Remove</command:verb> <command:noun>ModuleManifestComments</command:noun> <maml:description> <maml:para>Removes comments from module manifest files.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes all comments from PowerShell module manifests. The end result is a file that's less cluttered and easier to read.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ModuleManifestComments</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>ManifestPath</maml:name> <maml:Description> <maml:para>The path to the module 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoConfirm</maml:name> <maml:Description> <maml:para>Do not confirm before overwriting the manifest file.</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>ManifestPath</maml:name> <maml:Description> <maml:para>The path to the module 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoConfirm</maml:name> <maml:Description> <maml:para>Do not confirm before overwriting the manifest file.</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.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <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:\> Remove-ModuleManifestComments ".\MyManifest.psd1" -NoConfirm</dev:code> <dev:remarks> <maml:para>Loads `.\MyManifest.psd1`, removes all comments, and overwrites the existing file without confirming.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-ModuleManifestComments</maml:linkText> <maml:uri>https://github.com/refactorsaurusrex/whats-new/wiki/Remove-ModuleManifestComments</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |