Generate XML documentation on build and add to it NuGet package

also fixed issues with xml docs in the code implements #1876
pythonnet · lostmsu · Jun 27, 2022 · Jun 30, 2022 · Jun 28, 2022 · Jul 5, 2022
commit 8ebfb18a4b3b60e1092be71970d1c34d3cda18d4
diff --git a/src/runtime/AssemblyManager.cs b/src/runtime/AssemblyManager.cs
@@ -334,7 +334,7 @@ public static bool IsValidNamespace(string name)
         }
 
         /// <summary>
-        /// Returns an IEnumerable<string> containing the namepsaces exported
+        /// Returns an enumerable collection containing the namepsaces exported
         /// by loaded assemblies in the current app domain.
         /// </summary>
         public static IEnumerable<string> GetNamespaces ()

diff --git a/src/runtime/Python.Runtime.csproj b/src/runtime/Python.Runtime.csproj
@@ -23,6 +23,8 @@
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
 
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
+
     <AssemblyOriginatorKeyFile>..\pythonnet.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
 

diff --git a/src/runtime/Runtime.cs b/src/runtime/Runtime.cs
@@ -99,6 +99,7 @@ internal static int GetRun()
         internal static bool HostedInPython;
         internal static bool ProcessIsTerminating;
 
+        /// <summary>
         /// Initialize the runtime...
         /// </summary>
         /// <remarks>Always call this method from the Main thread.  After the

diff --git a/src/runtime/Types/ArrayObject.cs b/src/runtime/Types/ArrayObject.cs
@@ -520,7 +520,7 @@ static IntPtr AllocateBufferProcs()
         #endregion
 
         /// <summary>
-        /// <see cref="TypeManager.InitializeSlots(IntPtr, Type, SlotsHolder)"/>
+        /// <see cref="TypeManager.InitializeSlots(PyType, Type, SlotsHolder?)"/>
         /// </summary>
         public static void InitializeSlots(PyType type, ISet<string> initialized, SlotsHolder slotsHolder)
         {

diff --git a/src/runtime/Types/EventBinding.cs b/src/runtime/Types/EventBinding.cs
@@ -70,7 +70,6 @@ public static NewReference nb_inplace_subtract(BorrowedReference ob, BorrowedRef
             return new NewReference(ob);
         }
 
-        /// </summary>
         public static int tp_descr_set(BorrowedReference ds, BorrowedReference ob, BorrowedReference val)
             => EventObject.tp_descr_set(ds, ob, val);
 

diff --git a/src/runtime/Types/ReflectedClrType.cs b/src/runtime/Types/ReflectedClrType.cs
@@ -22,7 +22,6 @@ internal ReflectedClrType(BorrowedReference original) : base(original) { }
     /// </summary>
     /// <remarks>
     /// Returned <see cref="ReflectedClrType"/> might be partially initialized.
-    /// If you need fully initialized type, use <see cref="GetOrInitialize(ClassBase, Type)"/>
     /// </remarks>
     public static ReflectedClrType GetOrCreate(Type type)
     {