Generate XML documentation on build and add to it NuGet package (#1878)

lostmsu · web-flow · commit a5e9b55bb0aa · 2022-07-16T21:00:05.000+02:00
also fixed issues with xml docs in the code implements #1876
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)
     {

Original file line number	Diff line number	Diff line change
`@@ -334,7 +334,7 @@ public static bool IsValidNamespace(string name)`
`334`	`334`	`}`
`335`	`335`
`336`	`336`	`/// <summary>`
`337`		`- /// Returns an IEnumerable<string> containing the namepsaces exported`
	`337`	`+ /// Returns an enumerable collection containing the namepsaces exported`
`338`	`338`	`/// by loaded assemblies in the current app domain.`
`339`	`339`	`/// </summary>`
`340`	`340`	`public static IEnumerable<string> GetNamespaces ()`
Original file line number	Diff line number	Diff line change
`@@ -520,7 +520,7 @@ static IntPtr AllocateBufferProcs()`
`520`	`520`	`#endregion`
`521`	`521`
`522`	`522`	`/// <summary>`
`523`		`- /// <see cref="TypeManager.InitializeSlots(IntPtr, Type, SlotsHolder)"/>`
	`523`	`+ /// <see cref="TypeManager.InitializeSlots(PyType, Type, SlotsHolder?)"/>`
`524`	`524`	`/// </summary>`
`525`	`525`	`public static void InitializeSlots(PyType type, ISet<string> initialized, SlotsHolder slotsHolder)`
`526`	`526`	`{`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,6 @@ public static NewReference nb_inplace_subtract(BorrowedReference ob, BorrowedRef`
`70`	`70`	`return new NewReference(ob);`
`71`	`71`	`}`
`72`	`72`
`73`		`- /// </summary>`
`74`	`73`	`public static int tp_descr_set(BorrowedReference ds, BorrowedReference ob, BorrowedReference val)`
`75`	`74`	`=> EventObject.tp_descr_set(ds, ob, val);`
`76`	`75`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ internal ReflectedClrType(BorrowedReference original) : base(original) { }`
`22`	`22`	`/// </summary>`
`23`	`23`	`/// <remarks>`
`24`	`24`	`/// Returned <see cref="ReflectedClrType"/> might be partially initialized.`
`25`		`- /// If you need fully initialized type, use <see cref="GetOrInitialize(ClassBase, Type)"/>`
`26`	`25`	`/// </remarks>`
`27`	`26`	`public static ReflectedClrType GetOrCreate(Type type)`
`28`	`27`	`{`