Skip to content

Commit c04e15f

Browse files
Add documentation for Java interop types. (#120964)
Fixes #120504
1 parent 70fd4cf commit c04e15f

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/ComponentCrossReference.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
namespace System.Runtime.InteropServices.Java
77
{
8+
/// <summary>
9+
/// Represents a cross-reference between two tracked component groups.
10+
/// </summary>
811
[CLSCompliant(false)]
912
[SupportedOSPlatform("android")]
1013
[StructLayout(LayoutKind.Sequential)]

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/MarkCrossReferencesArgs.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,33 @@
55

66
namespace System.Runtime.InteropServices.Java
77
{
8+
/// <summary>
9+
/// Data for the callback supplied to <see cref="O:JavaMarshal.Initialize" />
10+
/// for marking managed objects referenced from Java during cross-reference processing.
11+
/// </summary>
812
[CLSCompliant(false)]
913
[SupportedOSPlatform("android")]
1014
[StructLayout(LayoutKind.Sequential)]
1115
public unsafe struct MarkCrossReferencesArgs
1216
{
17+
/// <summary>
18+
/// The number of strongly connected components being reported.
19+
/// </summary>
1320
public nuint ComponentCount;
21+
22+
/// <summary>
23+
/// A pointer to the array of strongly connected components.
24+
/// </summary>
1425
public StronglyConnectedComponent* Components;
26+
27+
/// <summary>
28+
/// The number of cross-references being reported.
29+
/// </summary>
1530
public nuint CrossReferenceCount;
31+
32+
/// <summary>
33+
/// A pointer to the array of cross-references.
34+
/// </summary>
1635
public ComponentCrossReference* CrossReferences;
1736
}
1837
}

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Java/StronglyConnectedComponent.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55

66
namespace System.Runtime.InteropServices.Java
77
{
8+
/// <summary>
9+
/// Represents a strongly connected component of managed objects
10+
/// referenced for cross-reference processing.
11+
/// </summary>
812
[CLSCompliant(false)]
913
[SupportedOSPlatform("android")]
1014
[StructLayout(LayoutKind.Sequential)]

0 commit comments

Comments
 (0)