GetTargetChoice.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-TargetChoice --> <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"> <command:details> <command:name>Get-TargetChoice</command:name> <command:verb>Get</command:verb> <command:noun>TargetChoice</command:noun> <maml:description> <maml:para>Function to ask question to user to choose between Debug or Release target</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function ask question to the user and wait the choice of the user between '0' (Debug) and '1' (Release).</maml:para> <maml:para>When the user choices a right option, the function returns the target string resulting : Debug if it is '0', Release if it is '1'</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-TargetChoice</maml:name> <!-- Parameter: Question --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="q"> <maml:name>Question</maml:name> <maml:description> <maml:para>The question asked user</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Question --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="q"> <maml:name>Question</maml:name> <maml:description> <maml:para>The question asked user</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="q"> <maml:name>q</maml:name> <maml:description> <maml:para>The question asked user</maml:para> <maml:para>This is an alias of the Question parameter.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The question asked user</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Usage</maml:para> <maml:para>Get-TargetChoice("What the target [0-Debug] / [1-Release] ?")</maml:para> </maml:introduction> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Source code</maml:linkText> <maml:uri>https://github.com/toenn-vaot/psmodule-get-target-choice</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |