Skip to content

Fix command doc generation #917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ogail merged 5 commits into from
Sep 17, 2015
Merged

Fix command doc generation #917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
898b484
Fix command doc generation
Sep 16, 2015
9f4c889
Fix bad chars in xml
Sep 16, 2015
1548031
Fix build for release target
Sep 16, 2015
6b72848
Fix csproj dependencies not to use strong name
Sep 17, 2015
f00ba19
Use Debug target instead for doc gen
Sep 17, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ...ourceManager/ApiManagement/Commands.ApiManagement.Test/Commands.ApiManagement.Test.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,17 @@
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\packages\Microsoft.Azure.Common.2.1.0\lib\net45\Microsoft.Azure.Common.NetFramework.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.Gallery, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
<Reference Include="Microsoft.Azure.Gallery">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\Package\Debug\ResourceManager\AzureResourceManager\Resources\Microsoft.Azure.Gallery.dll</HintPath>
<HintPath>..\..\..\Package\$(Configuration)\ResourceManager\AzureResourceManager\Resources\Microsoft.Azure.Gallery.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.Management.ApiManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\packages\Microsoft.Azure.Management.ApiManagement.1.0.2-preview\lib\net40\Microsoft.Azure.Management.ApiManagement.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.Management.Authorization, Version=0.9.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
<Reference Include="Microsoft.Azure.Management.Authorization">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\Package\Debug\ResourceManager\AzureResourceManager\Resources\Microsoft.Azure.Management.Authorization.dll</HintPath>
<HintPath>..\..\..\Package\$(Configuration)\ResourceManager\AzureResourceManager\Resources\Microsoft.Azure.Management.Authorization.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.Management.Storage">
<HintPath>..\..\..\packages\Microsoft.Azure.Management.Storage.2.4.0-preview\lib\net40\Microsoft.Azure.Management.Storage.dll</HintPath>
Expand Down
8 changes: 4 additions & 4 deletions ...er/ApiManagement/Commands.SMAPI.Test/Commands.ApiManagement.ServiceManagement.Test.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,17 @@
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\packages\Microsoft.Azure.Common.2.1.0\lib\net45\Microsoft.Azure.Common.NetFramework.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.Gallery, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
<Reference Include="Microsoft.Azure.Gallery">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\Package\Debug\ResourceManager\AzureResourceManager\Resources\Microsoft.Azure.Gallery.dll</HintPath>
<HintPath>..\..\..\Package\$(Configuration)\ResourceManager\AzureResourceManager\Resources\Microsoft.Azure.Gallery.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.Management.ApiManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\packages\Microsoft.Azure.Management.ApiManagement.1.0.2-preview\lib\net40\Microsoft.Azure.Management.ApiManagement.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.Management.Authorization, Version=0.9.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
<Reference Include="Microsoft.Azure.Management.Authorization">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\Package\Debug\ResourceManager\AzureResourceManager\Resources\Microsoft.Azure.Management.Authorization.dll</HintPath>
<HintPath>..\..\..\Package\$(Configuration)\ResourceManager\AzureResourceManager\Resources\Microsoft.Azure.Management.Authorization.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.Management.Storage">
<HintPath>..\..\..\packages\Microsoft.Azure.Management.Storage.2.4.0-preview\lib\net40\Microsoft.Azure.Management.Storage.dll</HintPath>
Expand Down
2 changes: 1 addition & 1 deletion ...tion/Commands.Automation/Microsoft.Azure.Commands.ResourceManager.Automation.dll-help.xml
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions src/ResourceManager/Dns/Commands.Dns/Commands.Dns.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,11 @@
<ItemGroup>
<WCFMetadata Include="Service References\" />
</ItemGroup>
<ItemGroup>
<Content Include="Microsoft.Azure.Commands.Dns.dll-Help.xml">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</Content>
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
<Import Project="..\..\..\packages\Microsoft.Bcl.Build.1.0.14\tools\Microsoft.Bcl.Build.targets" Condition="Exists('..\..\..\packages\Microsoft.Bcl.Build.1.0.14\tools\Microsoft.Bcl.Build.targets')" />
Expand Down
4 changes: 3 additions & 1 deletion src/ResourceManager/HDInsight/Commands.HDInsight/Commands.HDInsight.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,9 @@
</Reference>
</ItemGroup>
<ItemGroup>
<Content Include="Microsoft.Azure.Commands.HDInsight.dll-help.Help.xml" />
<Content Include="Microsoft.Azure.Commands.HDInsight.dll-help.xml">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</Content>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\..\Common\Commands.ResourceManager.Common\Commands.ResourceManager.Common.csproj">
Expand Down
0 ...zure.Commands.HDInsight.dll-help.Help.xml → ...oft.Azure.Commands.HDInsight.dll-help.xml
View file
Open in desktop
File renamed without changes.
20 changes: 10 additions & 10 deletions ...ResourceManager/KeyVault/Commands.KeyVault/Microsoft.Azure.Commands.KeyVault.dll-help.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Note: To import a key from your own hardware security module, you must first gen
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="KeyName">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the key to add to the vault. This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the vault, and your current environment. The name must be a string of 1 through 63 characters in length that contains only 0-9, a-z, A-Z, and � (the dash symbol).</maml:para>
<maml:para>Specifies the name of the key to add to the vault. This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the vault, and your current environment. The name must be a string of 1 through 63 characters in length that contains only 0-9, a-z, A-Z, and – (the dash symbol).</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
Expand Down Expand Up @@ -143,7 +143,7 @@ Note: To import a key from your own hardware security module, you must first gen
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="KeyName">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the key to add to the vault. This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the vault, and your current environment. The name must be a string of 1 through 63 characters in length that contains only 0-9, a-z, A-Z, and � (the dash symbol).</maml:para>
<maml:para>Specifies the name of the key to add to the vault. This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the vault, and your current environment. The name must be a string of 1 through 63 characters in length that contains only 0-9, a-z, A-Z, and – (the dash symbol).</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
</command:parameter>
Expand Down Expand Up @@ -310,7 +310,7 @@ Note: To import a key from your own hardware security module, you must first gen
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="KeyName">
<maml:name>Name</maml:name>
<maml:description>
<maml:para>Specifies the name of the key to add to the vault. This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the vault, and your current environment. The name must be a string of 1 through 63 characters in length that contains only 0-9, a-z, A-Z, and � (the dash symbol).</maml:para>
<maml:para>Specifies the name of the key to add to the vault. This cmdlet constructs the fully qualified domain name (FQDN) of a key based on the name that this parameter specifies, the name of the vault, and your current environment. The name must be a string of 1 through 63 characters in length that contains only 0-9, a-z, A-Z, and – (the dash symbol).</maml:para>
</maml:description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
Expand Down Expand Up @@ -451,7 +451,7 @@ Note: To import a key from your own hardware security module, you must first gen
PS C:\&gt; $Expires = (Get-Date).AddYears(2).ToUniversalTime()
PS C:\&gt; $NotBefore = (Get-Date).ToUniversalTime()
PS C:\&gt; $Tags = @{'Severity' = 'high'; 'Accounting' = null}
PS C:\&gt; Add-AzureRMKeyVaultKey -VaultName "Contoso" -Name "ITHsmNonDefault" -Destination "HSM" -Expires $Expires -NotBefore $NotBefore -KeyOps $KeyOperations �Disable -Tags $Tags
PS C:\&gt; Add-AzureRMKeyVaultKey -VaultName "Contoso" -Name "ITHsmNonDefault" -Destination "HSM" -Expires $Expires -NotBefore $NotBefore -KeyOps $KeyOperations –Disable -Tags $Tags
</dev:code>
<dev:remarks>
<maml:para>The first command stores the values decrypt and verify in the $KeyOperations variable.</maml:para>
Expand Down Expand Up @@ -1010,7 +1010,7 @@ PS C:\&gt; Add-AzureRMKeyVaultKey -VaultName "Contoso" -Name "ITPfxToHSM" -Desti
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\&gt;$Key = Get-AzureRMKeyVaultKey -VaultName "Contoso" -KeyName "ITPfx" �Version "5A12A276385949DB8B5F82AFEE85CAED"
<dev:code>PS C:\&gt;$Key = Get-AzureRMKeyVaultKey -VaultName "Contoso" -KeyName "ITPfx" –Version "5A12A276385949DB8B5F82AFEE85CAED"
</dev:code>
<dev:remarks>
<maml:para>This command gets a specific version of the key named ITPfx in the vault named Contoso. After running this command, you can inspect various properties of the key by navigating the $Key object.</maml:para>
Expand Down Expand Up @@ -1294,7 +1294,7 @@ PS C:\&gt; Add-AzureRMKeyVaultKey -VaultName "Contoso" -Name "ITPfxToHSM" -Desti
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\&gt;Get-AzureRMKeyVaultSecret -VaultName "Contoso" -Name "ITSecret" �Version "6A12A286385949DB8B5F82AFEF85CAE9"
<dev:code>PS C:\&gt;Get-AzureRMKeyVaultSecret -VaultName "Contoso" -Name "ITSecret" –Version "6A12A286385949DB8B5F82AFEF85CAE9"
</dev:code>
<dev:remarks>
<maml:para>This command gets a specific version of the secret named ITSecret in the vault named Contoso. </maml:para>
Expand Down Expand Up @@ -3574,7 +3574,7 @@ PS C:\&gt; Set-AzureRMKeyVaultAccessPolicy -VaultName "Contoso03Vault" -UserPrin
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\&gt;Set-AzureRMKeyVaultAccessPolicy -VaultName "Contoso03Vault" �ResourceGroupName "Group14" -EnabledForDeployment
<dev:code>PS C:\&gt;Set-AzureRMKeyVaultAccessPolicy -VaultName "Contoso03Vault" –ResourceGroupName "Group14" -EnabledForDeployment
</dev:code>
<dev:remarks>
<maml:para>This command grants the permissions for secrets to be retrieved from the Contoso03Vault vault by the Microsoft.Compute resource provider. </maml:para>
Expand Down Expand Up @@ -3896,7 +3896,7 @@ PS C:\&gt; Set-AzureRMKeyVaultKeyAttribute -VaultName "Contoso" -Name "ITSoftwar
<maml:para>
</maml:para>
</maml:introduction>
<dev:code>PS C:\&gt;Set-AzureRMKeyVaultKeyAttribute -VaultName "Contoso" -Name "ITSoftware" �Version "7EEA45C6EE50490B9C3176F80AC1A0DG" �Tags @{}
<dev:code>PS C:\&gt;Set-AzureRMKeyVaultKeyAttribute -VaultName "Contoso" -Name "ITSoftware" –Version "7EEA45C6EE50490B9C3176F80AC1A0DG" –Tags @{}
</dev:code>
<dev:remarks>
<maml:para>This commands deletes all tags for a specific version of a key named ITSoftware. </maml:para>
Expand Down Expand Up @@ -3979,7 +3979,7 @@ PS C:\&gt; Set-AzureRMKeyVaultKeyAttribute -VaultName "Contoso" -Name "ITSoftwar
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Enable</maml:name>
<maml:description>
<maml:para>Indicates whether to enable a secret. Specify $False to disable a secret, or $True to enable a secret. If you do not specify this parameter, there is no change to the current secret�s enabled or disabled state.</maml:para>
<maml:para>Indicates whether to enable a secret. Specify $False to disable a secret, or $True to enable a secret. If you do not specify this parameter, there is no change to the current secret–s enabled or disabled state.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
</command:parameter>
Expand Down Expand Up @@ -4035,7 +4035,7 @@ PS C:\&gt; Set-AzureRMKeyVaultKeyAttribute -VaultName "Contoso" -Name "ITSoftwar
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">
<maml:name>Enable</maml:name>
<maml:description>
<maml:para>Indicates whether to enable a secret. Specify $False to disable a secret, or $True to enable a secret. If you do not specify this parameter, there is no change to the current secret�s enabled or disabled state.</maml:para>
<maml:para>Indicates whether to enable a secret. Specify $False to disable a secret, or $True to enable a secret. If you do not specify this parameter, there is no change to the current secret–s enabled or disabled state.</maml:para>
</maml:description>
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
<dev:type>
Expand Down
4 changes: 2 additions & 2 deletions ...Manager/TrafficManager/Commands.TrafficManager2.Test/Commands.TrafficManager2.Test.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@
<HintPath>..\..\..\packages\Microsoft.Azure.Management.Authorization.1.0.0\lib\net40\Microsoft.Azure.Management.Authorization.dll</HintPath>
<Private>True</Private>
</Reference>
<Reference Include="Microsoft.Azure.Management.TrafficManager, Version=0.9.1.0, Culture=neutral, processorArchitecture=MSIL">
<Reference Include="Microsoft.Azure.Management.TrafficManager">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\..\..\Package\Debug\ResourceManager\AzureResourceManager\TrafficManager\Microsoft.Azure.Management.TrafficManager.dll</HintPath>
<HintPath>..\..\..\Package\$(Configuration)\ResourceManager\AzureResourceManager\TrafficManager\Microsoft.Azure.Management.TrafficManager.dll</HintPath>
</Reference>
<Reference Include="Microsoft.Azure.ResourceManager, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion>
Expand Down
4 changes: 2 additions & 2 deletions src/ServiceManagement/RemoteApp/Commands.RemoteApp/Commands.RemoteApp.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@
</EmbeddedResource>
</ItemGroup>
<ItemGroup>
<Content Include="Microsoft.Azure.Commands.RemoteApp.dll-help.xml">
<Content Include="Microsoft.WindowsAzure.Commands.RemoteApp.dll-help.xml">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</Content>
</ItemGroup>
Expand All @@ -250,4 +250,4 @@
<Target Name="AfterBuild">
</Target>
-->
</Project>
</Project>
0 ...oft.Azure.Commands.RemoteApp.dll-help.xml → ...dowsAzure.Commands.RemoteApp.dll-help.xml
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions tools/Docs/Get-AllCommands/Get-AllCommands.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ function Split-HelpFiles {
{
$xml = $cmdlet.node.outerxml
$cmdletName = (($xml | select-xml -namespace $namespace -XPath "//command:name").node.innerxml).trim()
Set-content –value $xml –path $OutputPath\$CmdletName.xml -Encoding ASCII
Set-content -value $xml -path $OutputPath\$CmdletName.xml -Encoding ASCII
}
}
else { "Error 101: The input file does not contain cmdlet help topics. For help, send e-mail to PSHuddle." }
Expand Down Expand Up @@ -514,8 +514,8 @@ function Get-ScriptDirectory
Split-Path $Invocation.MyCommand.Path
}

$asmPath = Join-Path (Get-ScriptDirectory) "..\..\..\src\Package\Release\ServiceManagement\Azure\Azure.psd1"
$armPath = Join-Path (Get-ScriptDirectory) "..\..\..\src\Package\Release\ResourceManager\AzureResourceManager\AzureResourceManager.psd1"
$asmPath = Join-Path (Get-ScriptDirectory) "..\..\..\src\Package\Debug\ServiceManagement\Azure\Azure.psd1"
$armPath = Join-Path (Get-ScriptDirectory) "..\..\..\src\Package\Debug\ResourceManager\AzureResourceManager\AzureResourceManager.psd1"


Get-AllBuildServerCommands -OutputPath ".\Output\asm" -ManifestFullName $asmPath
Expand Down