Package XML documentation (#1689)

Directory.Build.props

@@ -0,0 +1,7 @@
+<Project>
+
+  <PropertyGroup>
+    <UseArtifactsOutput>true</UseArtifactsOutput>
+  </PropertyGroup>
+
+</Project>

Jint.Tests/Runtime/InteropTests.cs

@@ -3334,7 +3334,7 @@ try {
             Assert.Equal(3, result);
         }
 
-        private class MetadataWrapper : IDictionary<string, object?>
+        private class MetadataWrapper : IDictionary<string, object>
         {
             public IEnumerator<KeyValuePair<string, object>> GetEnumerator() => throw new NotImplementedException();
             IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
@@ -3370,7 +3370,7 @@ try {
         {
             private Dictionary<string, object> _dictionary = new();
 
-            public void SetInitial(object? value, string? key)
+            public void SetInitial(object value, string key)
             {
                 _dictionary[key] = value;
             }

Jint.sln

@@ -22,6 +22,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		README.md = README.md
 		.editorconfig = .editorconfig
 		Directory.Packages.props = Directory.Packages.props
+		Directory.Build.props = Directory.Build.props
 	EndProjectSection
 EndProject
 Global

Jint/Collections/DictionarySlim.cs

@@ -12,7 +12,7 @@ using System.Runtime.InteropServices;
 namespace Jint.Collections
 {
     /// <summary>
-    /// DictionarySlim<string, TValue> is similar to Dictionary<TKey, TValue> but optimized in three ways:
+    /// DictionarySlim&lt;string, TValue> is similar to Dictionary&lt;TKey, TValue> but optimized in three ways:
     /// 1) It allows access to the value by ref replacing the common TryGetValue and Add pattern.
     /// 2) It does not store the hash code (assumes it is cheap to equate values).
     /// 3) It does not accept an equality comparer (assumes Object.GetHashCode() and Object.Equals() or overridden implementation are cheap and sufficient).

Jint/Collections/StringDictionarySlim.cs

@@ -15,7 +15,7 @@ using System.Runtime.CompilerServices;
 namespace Jint.Collections
 {
     /// <summary>
-    /// DictionarySlim<string, TValue> is similar to Dictionary<TKey, TValue> but optimized in three ways:
+    /// DictionarySlim&lt;string, TValue> is similar to Dictionary&lt;TKey, TValue> but optimized in three ways:
     /// 1) It allows access to the value by ref replacing the common TryGetValue and Add pattern.
     /// 2) It does not store the hash code (assumes it is cheap to equate values).
     /// 3) It does not accept an equality comparer (assumes Object.GetHashCode() and Object.Equals() or overridden implementation are cheap and sufficient).

Jint/Jint.csproj

@@ -2,14 +2,23 @@
   <PropertyGroup>
     <NeutralLanguage>en-US</NeutralLanguage>
     <TargetFrameworks>net462;netstandard2.0;netstandard2.1;net6.0</TargetFrameworks>
+
     <AssemblyOriginatorKeyFile>Jint.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
-    <LangVersion>latest</LangVersion>
     <IsPackable>true</IsPackable>
+
+    <LangVersion>latest</LangVersion>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+
     <AnalysisLevel>latest-Recommended</AnalysisLevel>
+
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+
+    <NoWarn>$(NoWarn);1591</NoWarn>
+
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(TargetFramework)' == 'net6.0' or '$(TargetFramework)' == 'netstandard2.1' ">

Jint/Options.Extensions.cs

@@ -75,6 +75,7 @@ namespace Jint
         /// <summary>
         /// Sets maximum allowed depth of recursion.
         /// </summary>
+        /// <param name="options">Options to modify</param>
         /// <param name="maxRecursionDepth">
         /// The allowed depth.
         /// a) In case max depth is zero no recursion is allowed.
@@ -140,6 +141,7 @@ namespace Jint
         /// to change what values are returned for specific CLR objects, or if any value
         /// is returned at all.
         /// </summary>
+        /// <param name="options">Options to modify</param>
         /// <param name="accessor">
         /// The delegate to invoke for each CLR member. If the delegate
         /// returns <c>null</c>, the standard evaluation is performed.
@@ -246,6 +248,7 @@ namespace Jint
         /// Registers some custom logic to apply on an <see cref="Engine"/> instance when the options
         /// are loaded.
         /// </summary>
+        /// <param name="options">Options to modify</param>
         /// <param name="configuration">The action to register.</param>
         public static Options Configure(this Options options, Action<Engine> configuration)
         {

Jint/Options.cs

@@ -400,7 +400,7 @@ namespace Jint
         /// <remarks>
         /// Chrome and V8 based engines (ClearScript) that can handle 13955.
         /// When set to a different value except -1, it can reduce slight performance/stack trace readability drawback. (after hitting the engine's own limit),
-        /// When max stack size to be exceeded, Engine throws an exception <see cref="JavaScriptException">.
+        /// When max stack size to be exceeded, Engine throws an exception <see cref="JavaScriptException" />.
         /// </remarks>
         public int MaxExecutionStackCount { get; set; } = StackGuard.Disabled;
 

Jint/Runtime/Debugger/DebuggerStatementHandling.cs

@@ -16,7 +16,7 @@ namespace Jint.Runtime.Debugger
         Clr,
 
         /// <summary>
-        /// <c>debugger</c> statements will trigger a break in Jint's DebugHandler. See <see cref="Jint.Engine.Break"/>.
+        /// <c>debugger</c> statements will trigger a break in Jint's DebugHandler. See <see cref="DebugHandler.Break"/>.
         /// </summary>
         Script
     }