ManifestSample

4.1.4

CmdletSamples.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Get-Gizmo -->
  <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-Gizmo</command:name>
      <command:verb>Get</command:verb>
      <command:noun>Gizmo</command:noun>
      <maml:description>
        <maml:para>This is the cmdlet synopsis.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>This is part of the longer cmdlet description.</maml:para>
      <maml:para>Also part of the longer cmdlet description.</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Get-Gizmo</maml:name>
        <!-- Parameter: Flavor -->
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0">
          <maml:name>Flavor</maml:name>
          <maml:description>
            <maml:para>The flavor for the gizmo.</maml:para>
          </maml:description>
          <command:parameterValue required="true">FlavorTypes</command:parameterValue>
          <dev:type>
            <maml:name>CmdletSamples.FlavorTypes</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Chocolate</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: Quantity -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Quantity</maml:name>
          <maml:description>
            <maml:para>The quantity of the gizmo.</maml:para>
          </maml:description>
          <command:parameterValue required="true">int</command:parameterValue>
          <dev:type>
            <maml:name>System.Int32</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>42</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: SomeInteger -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>SomeInteger</maml:name>
          <command:parameterValue required="true">int</command:parameterValue>
          <dev:type>
            <maml:name>System.Int32</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>0</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: SomeSwitch -->
        <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
          <maml:name>SomeSwitch</maml:name>
          <command:parameterValue required="true">SwitchParameter</command:parameterValue>
          <dev:type>
            <maml:name>System.Management.Automation.SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: SomeString -->
        <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
          <maml:name>SomeString</maml:name>
          <maml:description>
            <maml:para>Main description for 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>
        <!-- Parameter: SomeDateTime -->
        <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
          <maml:name>SomeDateTime</maml:name>
          <command:parameterValue required="true">DateTime</command:parameterValue>
          <dev:type>
            <maml:name>System.DateTime</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: MyContainer -->
        <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
          <maml:name>MyContainer</maml:name>
          <command:parameterValue required="true">Container</command:parameterValue>
          <dev:type>
            <maml:name>CmdletSamples.Container</maml:name>
            <maml:uri />
            <maml:description>
              <maml:para>Container object.</maml:para>
            </maml:description>
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: Flavor -->
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0">
        <maml:name>Flavor</maml:name>
        <maml:description>
          <maml:para>The flavor for the gizmo.</maml:para>
        </maml:description>
        <command:parameterValue required="true">FlavorTypes</command:parameterValue>
        <dev:type>
          <maml:name>CmdletSamples.FlavorTypes</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Chocolate</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: Quantity -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Quantity</maml:name>
        <maml:description>
          <maml:para>The quantity of the gizmo.</maml:para>
        </maml:description>
        <command:parameterValue required="true">int</command:parameterValue>
        <dev:type>
          <maml:name>System.Int32</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>42</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: SomeInteger -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>SomeInteger</maml:name>
        <command:parameterValue required="true">int</command:parameterValue>
        <dev:type>
          <maml:name>System.Int32</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>0</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: SomeSwitch -->
      <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
        <maml:name>SomeSwitch</maml:name>
        <command:parameterValue required="true">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: SomeString -->
      <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
        <maml:name>SomeString</maml:name>
        <maml:description>
          <maml:para>Main description for 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>
      <!-- Parameter: SomeDateTime -->
      <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
        <maml:name>SomeDateTime</maml:name>
        <command:parameterValue required="true">DateTime</command:parameterValue>
        <dev:type>
          <maml:name>System.DateTime</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>1/1/0001 12:00:00 AM</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: MyContainer -->
      <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
        <maml:name>MyContainer</maml:name>
        <command:parameterValue required="true">Container</command:parameterValue>
        <dev:type>
          <maml:name>CmdletSamples.Container</maml:name>
          <maml:uri />
          <maml:description>
            <maml:para>Container object.</maml:para>
          </maml:description>
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>CmdletSamples.FlavorTypes</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>The flavor for the gizmo.</maml:para>
        </maml:description>
      </command:inputType>
      <command:inputType>
        <dev:type>
          <maml:name>System.Management.Automation.SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
      </command:inputType>
      <command:inputType>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>Input description for parameter.</maml:para>
        </maml:description>
      </command:inputType>
      <command:inputType>
        <dev:type>
          <maml:name>System.DateTime</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>Description for input only.</maml:para>
        </maml:description>
      </command:inputType>
      <command:inputType>
        <dev:type>
          <maml:name>CmdletSamples.Container</maml:name>
          <maml:uri />
          <maml:description>
            <maml:para>Container object.</maml:para>
          </maml:description>
        </dev:type>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <!-- OutputType: Gizmo -->
      <command:returnValue>
        <dev:type>
          <maml:name>CmdletSamples.Gizmo</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>Description of the Gizmo class.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>[My Web Page]</maml:linkText>
        <maml:uri>(http://tempuri.org)</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>about_Gizmos</maml:linkText>
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
</helpItems>