@joebigelow / wix / commits / 8d27ac8b

Enable XML doc.

Sean Hall committed Dec 18, 2020 at 17:55 UTC 8d27ac8bd8eb8ec320714a0bc201b05728da2206

10 files changed +34 -19

src/CSharp.Build.props

@@ -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

@@ -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 @@

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.Data/Intermediate.cs

+6 -9

@@ -121,7 +121,6 @@ namespace WixToolset.Data

121 /// Loads an intermediate from a WixOutput object.

122 /// </summary>

123 /// <param name="wixOutput">WixOutput object.</param>

124 - /// <param name="creator">ISymbolDefinitionCreator to use when reconstituting the intermediate.</param>

124 /// <param name="suppressVersionCheck">Suppress checking for wix.dll version mismatches.</param>

125 /// <returns>Returns the loaded intermediate.</returns>

126 public static Intermediate Load(WixOutput wixOutput, bool suppressVersionCheck = false)

@@ -146,7 +145,6 @@ namespace WixToolset.Data

145 /// Loads several intermediates from paths on disk using the same definitions.

146 /// </summary>

147 /// <param name="intermediateFiles">Paths to intermediate files saved on disk.</param>

149 - /// <param name="suppressVersionCheck">Suppress checking for wix.dll version mismatches.</param>

148 /// <returns>Returns the loaded intermediates</returns>

149 public static IEnumerable<Intermediate> Load(IEnumerable<string> intermediateFiles)

150 {

@@ -225,9 +223,9 @@ namespace WixToolset.Data

223 }

224

225 /// <summary>

228 - /// Saves an intermediate to a path on disk.

226 + /// Saves an intermediate to a WixOutput.

227 /// </summary>

230 - /// <param name="path">Path to save intermediate file to disk.</param>

228 + /// <param name="wixout">Destination to save.</param>

229 public void Save(WixOutput wixout)

230 {

231 this.SaveEmbedFiles(wixout);

@@ -236,10 +234,9 @@ namespace WixToolset.Data

234 }

235

236 /// <summary>

239 - /// Loads an intermediate from a path on disk.

237 + /// Loads an intermediate from a WixOutput.

238 /// </summary>

241 - /// <param name="stream">Stream to intermediate file.</param>

242 - /// <param name="baseUri">Path name of intermediate file.</param>

239 + /// <param name="wixout">Source to load from.</param>

240 /// <param name="creator">ISymbolDefinitionCreator to use when reconstituting the intermediate.</param>

241 /// <param name="suppressVersionCheck">Suppress checking for wix.dll version mismatches.</param>

242 /// <returns>Returns the loaded intermediate.</returns>

@@ -254,9 +251,9 @@ namespace WixToolset.Data

251 }

252

253 /// <summary>

257 - /// Loads json form of intermedaite from stream.

254 + /// Loads json form of intermediate.

255 /// </summary>

259 - /// <param name="stream">Stream to intermediate file.</param>

256 + /// <param name="json">Source to load from.</param>

257 /// <param name="baseUri">Path name of intermediate file.</param>

258 /// <param name="suppressVersionCheck">Suppress checking for wix.dll version mismatches.</param>

259 /// <returns>Returns the loaded json.</returns>

src/WixToolset.Data/WindowsInstaller/ColumnDefinition.cs

@@ -29,6 +29,7 @@ namespace WixToolset.Data.WindowsInstaller

29 /// <param name="modularizeType">Type of modularization for column</param>

30 /// <param name="forceLocalizable">If the column is localizable.</param>

31 /// <param name="useCData">If whitespace should be preserved in a CDATA node.</param>

32 + /// <param name="unreal">If not saved to MSI.</param>

33 public ColumnDefinition(string name, ColumnType type, int length, bool primaryKey, bool nullable, ColumnCategory category, long? minValue = null, long? maxValue = null, string keyTable = null, int? keyColumn = null, string possibilities = null, string description = null, ColumnModularizeType? modularizeType = null, bool forceLocalizable = false, bool useCData = false, bool unreal = false)

34 {

35 this.Name = name;

src/WixToolset.Data/WindowsInstaller/Field.cs

+2 -2

@@ -64,7 +64,6 @@ namespace WixToolset.Data.WindowsInstaller

64 /// <summary>

65 /// Sets the value of a particular field in the row without validating.

66 /// </summary>

67 - /// <param name="field">field index.</param>

67 /// <param name="value">Value of a field in the row.</param>

68 /// <returns>True if successful, false if validation failed.</returns>

69 public bool BestEffortSet(object value)

@@ -133,8 +132,9 @@ namespace WixToolset.Data.WindowsInstaller

132 }

133

134 /// <summary>

136 - /// Validate a value for this column.

135 + /// Validate a value for a column.

136 /// </summary>

137 + /// <param name="column">The column.</param>

138 /// <param name="value">The value to validate.</param>

139 /// <returns>Validated value.</returns>

140 internal object ValidateValue(ColumnDefinition column, object value)

src/WixToolset.Data/WindowsInstaller/Rows/SummaryInfoRowCollection.cs

+1 -1

@@ -32,7 +32,7 @@ namespace WixToolset.Data.WindowsInstaller.Rows

32 /// Gets the summary property ID for the <paramref name="row"/>.

33 /// </summary>

34 /// <param name="row">The row to index.</param>

35 - /// <returns>The summary property ID for the <paramref name="row"/>.

35 + /// <returns>The summary property ID for the <paramref name="row"/>.</returns>

36 protected override int GetKeyForItem(Row row)

37 {

38 return (int)row[0];

src/WixToolset.Data/WindowsInstaller/TableDefinition.cs

@@ -26,6 +26,7 @@ namespace WixToolset.Data.WindowsInstaller

26 /// <param name="columns">Column definitions for the table.</param>

27 /// <param name="unreal">Flag if table is unreal.</param>

28 /// <param name="symbolIdIsPrimaryKey">Whether the primary key is the id of the symbol definition associated with this table.</param>

29 + /// <param name="strongRowType">The specialized type for the rows.</param>

30 public TableDefinition(string name, IntermediateSymbolDefinition symbolDefinition, IEnumerable<ColumnDefinition> columns, bool unreal = false, bool symbolIdIsPrimaryKey = false, Type strongRowType = null)

31 {

32 this.Name = name;

src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs

+1 -2

@@ -70,7 +70,6 @@ namespace WixToolset.Data.WindowsInstaller

70 /// Ensure this output contains a particular table.

71 /// </summary>

72 /// <param name="tableDefinition">Definition of the table that should exist.</param>

73 - /// <param name="section">Optional section to use for the table. If one is not provided, the entry section will be used.</param>

73 /// <returns>The table in this output.</returns>

74 public Table EnsureTable(TableDefinition tableDefinition)

75 {

@@ -98,7 +97,7 @@ namespace WixToolset.Data.WindowsInstaller

97 /// <summary>

98 /// Saves an output to an <c>XmlWriter</c>.

99 /// </summary>

101 - /// <param name="wixout">XmlWriter to save to.</param>

100 + /// <param name="writer">XmlWriter to save to.</param>

101 public void Save(XmlWriter writer)

102 {

103 writer.WriteStartDocument();

src/WixToolset.Data/WixOutput.cs

+9 -3

@@ -24,6 +24,9 @@ namespace WixToolset.Data

24 this.stream = stream;

25 }

27 + /// <summary>

28 + ///

29 + /// </summary>

30 public Uri Uri { get; }

32 /// <summary>

@@ -60,8 +63,8 @@ namespace WixToolset.Data

63 /// <summary>

64 /// Creates a new file structure.

65 /// </summary>

66 + /// <param name="uri"></param>

67 /// <param name="stream">Stream to write the file structure to.</param>

64 - /// <param name="embedFilePaths">Paths to files to embedd in the file structure.</param>

68 /// <returns>Newly created <c>WixOutput</c>.</returns>

69 public static WixOutput Create(Uri uri, Stream stream)

70 {

@@ -109,9 +112,11 @@ namespace WixToolset.Data

112 }

113

114 /// <summary>

112 - /// Loads a wixout from a assembly resource stream.

115 + /// Loads a wixout from an assembly resource stream.

116 /// </summary>

114 - /// <param name="path">Path to wixout file saved on disk.</param>

117 + /// <param name="assembly"></param>

118 + /// <param name="resourceName"></param>

119 + /// <returns>Loaded created <c>WixOutput</c>.</returns>

120 public static WixOutput Read(Assembly assembly, string resourceName)

121 {

122 var resourceStream = assembly.GetManifestResourceStream(resourceName);

@@ -128,6 +133,7 @@ namespace WixToolset.Data

133 /// <summary>

134 /// Reads a file structure from an open stream.

135 /// </summary>

136 + /// <param name="uri"></param>

137 /// <param name="stream">Stream to read from.</param>

138 /// <returns>Loaded created <c>WixOutput</c>.</returns>

139 public static WixOutput Read(Uri uri, Stream stream)

src/WixToolset.Data/WixToolset.Data.csproj

+4 -2

@@ -6,10 +6,12 @@

6 <TargetFrameworks>netstandard2.0</TargetFrameworks>

7 <TargetFrameworks Condition=" '$(Configuration)'=='Release' ">$(TargetFrameworks);net461;net472</TargetFrameworks>

8 <LangVersion>7.3</LangVersion>

9 - <Title>WiX Toolset Data</Title>

10 - <Description></Description>

9 + <Description>WiX Toolset Data</Description>

10 <DebugType>embedded</DebugType>

11 <PublishRepositoryUrl>true</PublishRepositoryUrl>

12 + <CreateDocumentationFile>true</CreateDocumentationFile>

13 +

14 + <NoWarn>CS1591</NoWarn>

15 </PropertyGroup>

17 <ItemGroup>