From 8d27ac8bd8eb8ec320714a0bc201b05728da2206 Mon Sep 17 00:00:00 2001
From: Sean Hall <r.sean.hall@gmail.com>
Date: Fri, 18 Dec 2020 17:55:28 -0600
Subject: Enable XML doc.

---
 src/CSharp.Build.props                                    |  1 +
 src/Directory.Build.targets                               |  8 ++++++++
 src/WixToolset.Data/Intermediate.cs                       | 15 ++++++---------
 src/WixToolset.Data/WindowsInstaller/ColumnDefinition.cs  |  1 +
 src/WixToolset.Data/WindowsInstaller/Field.cs             |  4 ++--
 .../WindowsInstaller/Rows/SummaryInfoRowCollection.cs     |  2 +-
 src/WixToolset.Data/WindowsInstaller/TableDefinition.cs   |  1 +
 .../WindowsInstaller/WindowsInstallerData.cs              |  3 +--
 src/WixToolset.Data/WixOutput.cs                          | 12 +++++++++---
 src/WixToolset.Data/WixToolset.Data.csproj                |  6 ++++--
 10 files changed, 34 insertions(+), 19 deletions(-)

(limited to 'src')

diff --git a/src/CSharp.Build.props b/src/CSharp.Build.props
index bcd47a0c..81d24ad1 100644
--- a/src/CSharp.Build.props
+++ b/src/CSharp.Build.props
@@ -8,5 +8,6 @@
     <CheckForOverflowUnderflow>true</CheckForOverflowUnderflow>
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>$([System.IO.Path]::GetFullPath($(MSBuildThisFileDirectory)wix.snk))</AssemblyOriginatorKeyFile>
+    <NBGV_EmitThisAssemblyClass>false</NBGV_EmitThisAssemblyClass>
   </PropertyGroup>
 </Project>
diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets
index dac7452a..cb988931 100644
--- a/src/Directory.Build.targets
+++ b/src/Directory.Build.targets
@@ -9,6 +9,11 @@
   See the original here: https://github.com/dotnet/sdk/issues/1151#issuecomment-385133284
 -->
 <Project>
+  <PropertyGroup>
+    <CreateDocumentation Condition=" '$(CreateDocumentationFile)'!='true' ">false</CreateDocumentation>
+    <DocumentationFile Condition=" '$(CreateDocumentationFile)'=='true' ">$(OutputPath)\$(AssemblyName).xml</DocumentationFile>
+  </PropertyGroup>
+
   <PropertyGroup>
     <ReplacePackageReferences>true</ReplacePackageReferences>
     <TheSolutionPath Condition=" '$(NCrunch)'=='' ">$(SolutionPath)</TheSolutionPath>
@@ -45,4 +50,7 @@
 
     </When>
   </Choose>
+
+  <Import Project="Wix.Build.targets" Condition=" Exists('Wix.Build.targets') And '$(MSBuildProjectExtension)'=='.wixproj' " />
+  <Import Project="Custom.Build.targets" Condition=" Exists('Custom.Build.targets') " />
 </Project>
diff --git a/src/WixToolset.Data/Intermediate.cs b/src/WixToolset.Data/Intermediate.cs
index 30a50120..f9d33839 100644
--- a/src/WixToolset.Data/Intermediate.cs
+++ b/src/WixToolset.Data/Intermediate.cs
@@ -121,7 +121,6 @@ namespace WixToolset.Data
         /// Loads an intermediate from a WixOutput object.
         /// </summary>
         /// <param name="wixOutput">WixOutput object.</param>
-        /// <param name="creator">ISymbolDefinitionCreator to use when reconstituting the intermediate.</param>
         /// <param name="suppressVersionCheck">Suppress checking for wix.dll version mismatches.</param>
         /// <returns>Returns the loaded intermediate.</returns>
         public static Intermediate Load(WixOutput wixOutput, bool suppressVersionCheck = false)
@@ -146,7 +145,6 @@ namespace WixToolset.Data
         /// Loads several intermediates from paths on disk using the same definitions.
         /// </summary>
         /// <param name="intermediateFiles">Paths to intermediate files saved on disk.</param>
-        /// <param name="suppressVersionCheck">Suppress checking for wix.dll version mismatches.</param>
         /// <returns>Returns the loaded intermediates</returns>
         public static IEnumerable<Intermediate> Load(IEnumerable<string> intermediateFiles)
         {
@@ -225,9 +223,9 @@ namespace WixToolset.Data
         }
 
         /// <summary>
-        /// Saves an intermediate to a path on disk.
+        /// Saves an intermediate to a WixOutput.
         /// </summary>
-        /// <param name="path">Path to save intermediate file to disk.</param>
+        /// <param name="wixout">Destination to save.</param>
         public void Save(WixOutput wixout)
         {
             this.SaveEmbedFiles(wixout);
@@ -236,10 +234,9 @@ namespace WixToolset.Data
         }
 
         /// <summary>
-        /// Loads an intermediate from a path on disk.
+        /// Loads an intermediate from a WixOutput.
         /// </summary>
-        /// <param name="stream">Stream to intermediate file.</param>
-        /// <param name="baseUri">Path name of intermediate file.</param>
+        /// <param name="wixout">Source to load from.</param>
         /// <param name="creator">ISymbolDefinitionCreator to use when reconstituting the intermediate.</param>
         /// <param name="suppressVersionCheck">Suppress checking for wix.dll version mismatches.</param>
         /// <returns>Returns the loaded intermediate.</returns>
@@ -254,9 +251,9 @@ namespace WixToolset.Data
         }
 
         /// <summary>
-        /// Loads json form of intermedaite from stream.
+        /// Loads json form of intermediate.
         /// </summary>
-        /// <param name="stream">Stream to intermediate file.</param>
+        /// <param name="json">Source to load from.</param>
         /// <param name="baseUri">Path name of intermediate file.</param>
         /// <param name="suppressVersionCheck">Suppress checking for wix.dll version mismatches.</param>
         /// <returns>Returns the loaded json.</returns>
diff --git a/src/WixToolset.Data/WindowsInstaller/ColumnDefinition.cs b/src/WixToolset.Data/WindowsInstaller/ColumnDefinition.cs
index de554fd8..f4dbab34 100644
--- a/src/WixToolset.Data/WindowsInstaller/ColumnDefinition.cs
+++ b/src/WixToolset.Data/WindowsInstaller/ColumnDefinition.cs
@@ -29,6 +29,7 @@ namespace WixToolset.Data.WindowsInstaller
         /// <param name="modularizeType">Type of modularization for column</param>
         /// <param name="forceLocalizable">If the column is localizable.</param>
         /// <param name="useCData">If whitespace should be preserved in a CDATA node.</param>
+        /// <param name="unreal">If not saved to MSI.</param>
         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)
         {
             this.Name = name;
diff --git a/src/WixToolset.Data/WindowsInstaller/Field.cs b/src/WixToolset.Data/WindowsInstaller/Field.cs
index 84e8d543..e5edd552 100644
--- a/src/WixToolset.Data/WindowsInstaller/Field.cs
+++ b/src/WixToolset.Data/WindowsInstaller/Field.cs
@@ -64,7 +64,6 @@ namespace WixToolset.Data.WindowsInstaller
         /// <summary>
         /// Sets the value of a particular field in the row without validating.
         /// </summary>
-        /// <param name="field">field index.</param>
         /// <param name="value">Value of a field in the row.</param>
         /// <returns>True if successful, false if validation failed.</returns>
         public bool BestEffortSet(object value)
@@ -133,8 +132,9 @@ namespace WixToolset.Data.WindowsInstaller
         }
 
         /// <summary>
-        /// Validate a value for this column.
+        /// Validate a value for a column.
         /// </summary>
+        /// <param name="column">The column.</param>
         /// <param name="value">The value to validate.</param>
         /// <returns>Validated value.</returns>
         internal object ValidateValue(ColumnDefinition column, object value)
diff --git a/src/WixToolset.Data/WindowsInstaller/Rows/SummaryInfoRowCollection.cs b/src/WixToolset.Data/WindowsInstaller/Rows/SummaryInfoRowCollection.cs
index fc0410e9..4b2ce129 100644
--- a/src/WixToolset.Data/WindowsInstaller/Rows/SummaryInfoRowCollection.cs
+++ b/src/WixToolset.Data/WindowsInstaller/Rows/SummaryInfoRowCollection.cs
@@ -32,7 +32,7 @@ namespace WixToolset.Data.WindowsInstaller.Rows
         /// Gets the summary property ID for the <paramref name="row"/>.
         /// </summary>
         /// <param name="row">The row to index.</param>
-        /// <returns>The summary property ID for the <paramref name="row"/>.
+        /// <returns>The summary property ID for the <paramref name="row"/>.</returns>
         protected override int GetKeyForItem(Row row)
         {
             return (int)row[0];
diff --git a/src/WixToolset.Data/WindowsInstaller/TableDefinition.cs b/src/WixToolset.Data/WindowsInstaller/TableDefinition.cs
index 504c89ce..a7602d05 100644
--- a/src/WixToolset.Data/WindowsInstaller/TableDefinition.cs
+++ b/src/WixToolset.Data/WindowsInstaller/TableDefinition.cs
@@ -26,6 +26,7 @@ namespace WixToolset.Data.WindowsInstaller
         /// <param name="columns">Column definitions for the table.</param>
         /// <param name="unreal">Flag if table is unreal.</param>
         /// <param name="symbolIdIsPrimaryKey">Whether the primary key is the id of the symbol definition associated with this table.</param>
+        /// <param name="strongRowType">The specialized type for the rows.</param>
         public TableDefinition(string name, IntermediateSymbolDefinition symbolDefinition, IEnumerable<ColumnDefinition> columns, bool unreal = false, bool symbolIdIsPrimaryKey = false, Type strongRowType = null)
         {
             this.Name = name;
diff --git a/src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs b/src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs
index cc16bca5..8d69cd08 100644
--- a/src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs
+++ b/src/WixToolset.Data/WindowsInstaller/WindowsInstallerData.cs
@@ -70,7 +70,6 @@ namespace WixToolset.Data.WindowsInstaller
         /// Ensure this output contains a particular table.
         /// </summary>
         /// <param name="tableDefinition">Definition of the table that should exist.</param>
-        /// <param name="section">Optional section to use for the table. If one is not provided, the entry section will be used.</param>
         /// <returns>The table in this output.</returns>
         public Table EnsureTable(TableDefinition tableDefinition)
         {
@@ -98,7 +97,7 @@ namespace WixToolset.Data.WindowsInstaller
         /// <summary>
         /// Saves an output to an <c>XmlWriter</c>.
         /// </summary>
-        /// <param name="wixout">XmlWriter to save to.</param>
+        /// <param name="writer">XmlWriter to save to.</param>
         public void Save(XmlWriter writer)
         {
             writer.WriteStartDocument();
diff --git a/src/WixToolset.Data/WixOutput.cs b/src/WixToolset.Data/WixOutput.cs
index 969de991..43359f24 100644
--- a/src/WixToolset.Data/WixOutput.cs
+++ b/src/WixToolset.Data/WixOutput.cs
@@ -24,6 +24,9 @@ namespace WixToolset.Data
             this.stream = stream;
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
         public Uri Uri { get; }
 
         /// <summary>
@@ -60,8 +63,8 @@ namespace WixToolset.Data
         /// <summary>
         /// Creates a new file structure.
         /// </summary>
+        /// <param name="uri"></param>
         /// <param name="stream">Stream to write the file structure to.</param>
-        /// <param name="embedFilePaths">Paths to files to embedd in the file structure.</param>
         /// <returns>Newly created <c>WixOutput</c>.</returns>
         public static WixOutput Create(Uri uri, Stream stream)
         {
@@ -109,9 +112,11 @@ namespace WixToolset.Data
         }
 
         /// <summary>
-        /// Loads a wixout from a assembly resource stream.
+        /// Loads a wixout from an assembly resource stream.
         /// </summary>
-        /// <param name="path">Path to wixout file saved on disk.</param>
+        /// <param name="assembly"></param>
+        /// <param name="resourceName"></param>
+        /// <returns>Loaded created <c>WixOutput</c>.</returns>
         public static WixOutput Read(Assembly assembly, string resourceName)
         {
             var resourceStream = assembly.GetManifestResourceStream(resourceName);
@@ -128,6 +133,7 @@ namespace WixToolset.Data
         /// <summary>
         /// Reads a file structure from an open stream.
         /// </summary>
+        /// <param name="uri"></param>
         /// <param name="stream">Stream to read from.</param>
         /// <returns>Loaded created <c>WixOutput</c>.</returns>
         public static WixOutput Read(Uri uri, Stream stream)
diff --git a/src/WixToolset.Data/WixToolset.Data.csproj b/src/WixToolset.Data/WixToolset.Data.csproj
index 19310aea..24b0917b 100644
--- a/src/WixToolset.Data/WixToolset.Data.csproj
+++ b/src/WixToolset.Data/WixToolset.Data.csproj
@@ -6,10 +6,12 @@
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <TargetFrameworks Condition=" '$(Configuration)'=='Release' ">$(TargetFrameworks);net461;net472</TargetFrameworks>
     <LangVersion>7.3</LangVersion>
-    <Title>WiX Toolset Data</Title>
-    <Description></Description>
+    <Description>WiX Toolset Data</Description>
     <DebugType>embedded</DebugType>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <CreateDocumentationFile>true</CreateDocumentationFile>
+    <!-- TODO: This shouldn't be ignored because this is public-facing -->
+    <NoWarn>CS1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
-- 
cgit v1.2.3-55-g6feb