@joebigelow / wix / commits / 8296f237

Enable XML doc.

Sean Hall committed Dec 18, 2020 at 18:12 UTC 8296f237c69743d3e6cbdc58fc07e8470562b92e
12 files changed +56 -16
src/CSharp.Build.props
+1
@@ -8,5 +8,6 @@
8 <CheckForOverflowUnderflow>true</CheckForOverflowUnderflow>
9 <SignAssembly>true</SignAssembly>
10 <AssemblyOriginatorKeyFile>$([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)wix.snk))</AssemblyOriginatorKeyFile>
11 + <NBGV_EmitThisAssemblyClass>false</NBGV_EmitThisAssemblyClass>
12 </PropertyGroup>
13 </Project>
src/Directory.Build.targets
+8
@@ -9,6 +9,11 @@
9 See the original here: https://github.com/dotnet/sdk/issues/1151#issuecomment-385133284
10 -->
11 <Project>
12 + <PropertyGroup>
13 + <CreateDocumentation Condition=" '$(CreateDocumentationFile)'!='true' ">false</CreateDocumentation>
14 + <DocumentationFile Condition=" '$(CreateDocumentationFile)'=='true' ">$(OutputPath)\$(AssemblyName).xml</DocumentationFile>
15 + </PropertyGroup>
16 +
17 <PropertyGroup>
18 <ReplacePackageReferences>true</ReplacePackageReferences>
19 <TheSolutionPath Condition=" '$(NCrunch)'=='' ">$(SolutionPath)</TheSolutionPath>
@@ -45,4 +50,7 @@
50
51 </When>
52 </Choose>
53 +
54 + <Import Project="Wix.Build.targets" Condition=" Exists('Wix.Build.targets') And '$(MSBuildProjectExtension)'=='.wixproj' " />
55 + <Import Project="Custom.Build.targets" Condition=" Exists('Custom.Build.targets') " />
56 </Project>
src/WixToolset.Core.Native/CabInterop.cs
+3 -1
@@ -29,6 +29,7 @@ namespace WixToolset.Core.Native
29 /// </summary>
30 /// <param name="file">Full path to file to add to cabinet.</param>
31 /// <param name="token">Name of file in cabinet.</param>
32 + /// <param name="fileHash"></param>
33 /// <param name="contextHandle">Handle to open cabinet.</param>
34 [DllImport("winterop.dll", EntryPoint = "CreateCabAddFile", CharSet = CharSet.Unicode, ExactSpelling = true, PreserveSig = false)]
35 public static extern void CreateCabAddFile(string file, string token, MSIFILEHASHINFO fileHash, IntPtr contextHandle);
@@ -101,7 +102,8 @@ namespace WixToolset.Core.Native
102 /// to be exposed by .NET Frameowkr.
103 /// </summary>
104 /// <param name="certContext">Pointer to a CERT_CONTEXT struct with public key information to hash.</param>
104 - /// <param name="fileCount">Number of file paths in array.</param>
105 + /// <param name="publicKeyInfoHashed"></param>
106 + /// <param name="sizePublicKeyInfoHashed"></param>
107 [DllImport("winterop.dll", EntryPoint = "HashPublicKeyInfo", CharSet = CharSet.Unicode, ExactSpelling = true, PreserveSig = false)]
108 public static extern void HashPublicKeyInfo(IntPtr certContext, byte[] publicKeyInfoHashed, ref uint sizePublicKeyInfoHashed);
109
src/WixToolset.Core.Native/Cabinet.cs
+8 -2
@@ -15,19 +15,25 @@ namespace WixToolset.Core.Native
15 private const string CompressionLevelVariable = "WIX_COMPRESSION_LEVEL";
16 private static readonly char[] TextLineSplitter = new[] { '\t' };
17
18 + /// <summary>
19 + ///
20 + /// </summary>
21 + /// <param name="path">Path of cabinet</param>
22 public Cabinet(string path)
23 {
24 this.Path = path;
25 }
26
27 + /// <summary>
28 + /// Cabinet path.
29 + /// </summary>
30 public string Path { get; }
31
32 /// <summary>
33 /// Creates a cabinet.
34 /// </summary>
28 - /// <param name="cabPath">Path of cabinet to create.</param>
35 + /// <param name="files">Files to compress.</param>
36 /// <param name="compressionLevel">Level of compression to apply.</param>
30 - /// <param name="maxFiles">Maximum number of files that will be added to cabinet.</param>
37 /// <param name="maxSize">Maximum size of cabinet.</param>
38 /// <param name="maxThresh">Maximum threshold for each cabinet.</param>
39 public void Compress(IEnumerable<CabinetCompressFile> files, CompressionLevel compressionLevel, int maxSize = 0, int maxThresh = 0)
src/WixToolset.Core.Native/MSIFILEHASHINFO.cs
+15
@@ -10,10 +10,25 @@ namespace WixToolset.Core.Native
10 [StructLayout(LayoutKind.Explicit)]
11 public class MSIFILEHASHINFO
12 {
13 + /// <summary>
14 + ///
15 + /// </summary>
16 [FieldOffset(0)] public uint FileHashInfoSize;
17 + /// <summary>
18 + ///
19 + /// </summary>
20 [FieldOffset(4)] public int Data0;
21 + /// <summary>
22 + ///
23 + /// </summary>
24 [FieldOffset(8)] public int Data1;
25 + /// <summary>
26 + ///
27 + /// </summary>
28 [FieldOffset(12)] public int Data2;
29 + /// <summary>
30 + ///
31 + /// </summary>
32 [FieldOffset(16)] public int Data3;
33 }
34 }
src/WixToolset.Core.Native/MsmInterop.cs
+3
@@ -481,6 +481,9 @@ namespace WixToolset.Core.Native
481 [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
482 public interface IClassFactory
483 {
484 + /// <summary>
485 + ///
486 + /// </summary>
487 [return: MarshalAs(UnmanagedType.IUnknown)]
488 object CreateInstance(IntPtr unkOuter, [MarshalAs(UnmanagedType.LPStruct)] Guid iid);
489 }
src/WixToolset.Core.Native/WixToolset.Core.Native.csproj
+5 -1
@@ -1,3 +1,6 @@
1 +<?xml version="1.0" encoding="utf-8"?>
2 +<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
3 +
4 <Project Sdk="Microsoft.NET.Sdk">
5
6 <PropertyGroup>
@@ -6,6 +9,7 @@
9 <Description>Core Native</Description>
10 <DebugType>embedded</DebugType>
11 <IncludeSymbols>true</IncludeSymbols>
12 + <CreateDocumentationFile>true</CreateDocumentationFile>
13 </PropertyGroup>
14
15 <ItemGroup>
@@ -29,7 +33,7 @@
33
34 <ItemGroup>
35 <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
32 - <PackageReference Include="Nerdbank.GitVersioning" Version="3.1.91" PrivateAssets="all" />
36 + <PackageReference Include="Nerdbank.GitVersioning" Version="3.3.37" PrivateAssets="all" />
37 </ItemGroup>
38
39 <PropertyGroup>
src/WixToolset.Core.Native/WixToolset.Core.Native.nuspec
+1
@@ -18,6 +18,7 @@
18
19 <files>
20 <file src="netstandard2.0\$id$.dll" target="lib\netstandard2.0" />
21 + <file src="netstandard2.0\$id$.xml" target="lib\netstandard2.0" />
22
23 <file src="$mergemoddir$ARM64\mergemod.dll" target="runtimes\win-arm64\native" />
24 <file src="ARM64\wixnative.exe" target="runtimes\win-arm64\native" />
src/winterop/packages.config
+2 -2
@@ -3,6 +3,6 @@
3 <package id="Microsoft.Build.Tasks.Git" version="1.0.0" targetFramework="native" developmentDependency="true" />
4 <package id="Microsoft.SourceLink.Common" version="1.0.0" targetFramework="native" developmentDependency="true" />
5 <package id="Microsoft.SourceLink.GitHub" version="1.0.0" targetFramework="native" developmentDependency="true" />
6 - <package id="Nerdbank.GitVersioning" version="3.1.91" targetFramework="native" developmentDependency="true" />
7 - <package id="WixToolset.DUtil" version="4.0.41" targetFramework="native" />
6 + <package id="Nerdbank.GitVersioning" version="3.3.37" targetFramework="native" developmentDependency="true" />
7 + <package id="WixToolset.DUtil" version="4.0.56" targetFramework="native" />
8 </packages>
\ No newline at end of file
src/winterop/winterop.vcxproj
+4 -4
@@ -5,7 +5,7 @@
5 <Import Project="..\..\packages\Microsoft.SourceLink.GitHub.1.0.0\build\Microsoft.SourceLink.GitHub.props" Condition="Exists('..\..\packages\Microsoft.SourceLink.GitHub.1.0.0\build\Microsoft.SourceLink.GitHub.props')" />
6 <Import Project="..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.props" Condition="Exists('..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.props')" />
7 <Import Project="..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.props" Condition="Exists('..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.props')" />
8 - <Import Project="..\..\packages\WixToolset.DUtil.4.0.41\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.41\build\WixToolset.DUtil.props')" />
8 + <Import Project="..\..\packages\WixToolset.DUtil.4.0.56\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.56\build\WixToolset.DUtil.props')" />
9
10 <ItemGroup Label="ProjectConfigurations">
11 <ProjectConfiguration Include="Debug|ARM64">
@@ -51,7 +51,7 @@
51 </ImportGroup>
52
53 <ImportGroup Label="Shared">
54 - <Import Project="..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets" Condition="Exists('..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets')" />
54 + <Import Project="..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets" Condition="Exists('..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets')" />
55 <Import Project="..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.targets" Condition="Exists('..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.targets')" />
56 <Import Project="..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.targets" Condition="Exists('..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.targets')" />
57 <Import Project="..\..\packages\Microsoft.SourceLink.GitHub.1.0.0\build\Microsoft.SourceLink.GitHub.targets" Condition="Exists('..\..\packages\Microsoft.SourceLink.GitHub.1.0.0\build\Microsoft.SourceLink.GitHub.targets')" />
@@ -87,8 +87,8 @@
87 <PropertyGroup>
88 <ErrorText>This project references NuGet package(s) that are missing on this computer. Enable NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105.The missing file is {0}.</ErrorText>
89 </PropertyGroup>
90 - <Error Condition="!Exists('..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets'))" />
91 - <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.41\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.41\build\WixToolset.DUtil.props'))" />
90 + <Error Condition="!Exists('..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets'))" />
91 + <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.56\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.56\build\WixToolset.DUtil.props'))" />
92 <Error Condition="!Exists('..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.props'))" />
93 <Error Condition="!Exists('..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.targets'))" />
94 <Error Condition="!Exists('..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.props'))" />
src/wixnative/packages.config
+2 -2
@@ -3,6 +3,6 @@
3 <package id="Microsoft.Build.Tasks.Git" version="1.0.0" targetFramework="native" developmentDependency="true" />
4 <package id="Microsoft.SourceLink.Common" version="1.0.0" targetFramework="native" developmentDependency="true" />
5 <package id="Microsoft.SourceLink.GitHub" version="1.0.0" targetFramework="native" developmentDependency="true" />
6 - <package id="Nerdbank.GitVersioning" version="3.1.91" targetFramework="native" developmentDependency="true" />
7 - <package id="WixToolset.DUtil" version="4.0.41" targetFramework="native" />
6 + <package id="Nerdbank.GitVersioning" version="3.3.37" targetFramework="native" developmentDependency="true" />
7 + <package id="WixToolset.DUtil" version="4.0.56" targetFramework="native" />
8 </packages>
\ No newline at end of file
src/wixnative/wixnative.vcxproj
+4 -4
@@ -5,7 +5,7 @@
5 <Import Project="..\..\packages\Microsoft.SourceLink.GitHub.1.0.0\build\Microsoft.SourceLink.GitHub.props" Condition="Exists('..\..\packages\Microsoft.SourceLink.GitHub.1.0.0\build\Microsoft.SourceLink.GitHub.props')" />
6 <Import Project="..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.props" Condition="Exists('..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.props')" />
7 <Import Project="..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.props" Condition="Exists('..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.props')" />
8 - <Import Project="..\..\packages\WixToolset.DUtil.4.0.41\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.41\build\WixToolset.DUtil.props')" />
8 + <Import Project="..\..\packages\WixToolset.DUtil.4.0.56\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.56\build\WixToolset.DUtil.props')" />
9
10 <ItemGroup Label="ProjectConfigurations">
11 <ProjectConfiguration Include="Debug|ARM64">
@@ -50,7 +50,7 @@
50 </ImportGroup>
51
52 <ImportGroup Label="Shared">
53 - <Import Project="..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets" Condition="Exists('..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets')" />
53 + <Import Project="..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets" Condition="Exists('..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets')" />
54 <Import Project="..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.targets" Condition="Exists('..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.targets')" />
55 <Import Project="..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.targets" Condition="Exists('..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.targets')" />
56 <Import Project="..\..\packages\Microsoft.SourceLink.GitHub.1.0.0\build\Microsoft.SourceLink.GitHub.targets" Condition="Exists('..\..\packages\Microsoft.SourceLink.GitHub.1.0.0\build\Microsoft.SourceLink.GitHub.targets')" />
@@ -87,8 +87,8 @@
87 <PropertyGroup>
88 <ErrorText>This project references NuGet package(s) that are missing on this computer. Enable NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105.The missing file is {0}.</ErrorText>
89 </PropertyGroup>
90 - <Error Condition="!Exists('..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets'))" />
91 - <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.41\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.41\build\WixToolset.DUtil.props'))" />
90 + <Error Condition="!Exists('..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Nerdbank.GitVersioning.3.3.37\build\Nerdbank.GitVersioning.targets'))" />
91 + <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.56\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.56\build\WixToolset.DUtil.props'))" />
92 <Error Condition="!Exists('..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.props'))" />
93 <Error Condition="!Exists('..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Microsoft.Build.Tasks.Git.1.0.0\build\Microsoft.Build.Tasks.Git.targets'))" />
94 <Error Condition="!Exists('..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Microsoft.SourceLink.Common.1.0.0\build\Microsoft.SourceLink.Common.props'))" />