Skip to content

Add XML docs to NuGet #1878

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 16, 2022
Merged

Add XML docs to NuGet #1878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/runtime/AssemblyManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ()
Expand Down
2 changes: 2 additions & 0 deletions src/runtime/Python.Runtime.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>

<GenerateDocumentationFile>True</GenerateDocumentationFile>

<AssemblyOriginatorKeyFile>..\pythonnet.snk</AssemblyOriginatorKeyFile>
<SignAssembly>true</SignAssembly>

Expand Down
1 change: 1 addition & 0 deletions src/runtime/Runtime.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/runtime/Types/ArrayObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
1 change: 0 additions & 1 deletion src/runtime/Types/EventBinding.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
1 change: 0 additions & 1 deletion src/runtime/Types/ReflectedClrType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down