From d7ad8633f6f7e2f0c3d5a7e9437c37e1a91b2bbb Mon Sep 17 00:00:00 2001 From: Aaron Robinson Date: Fri, 3 Sep 2021 15:45:38 -0700 Subject: [PATCH 1/4] Update InteropServices doc --- xml/System.Runtime.InteropServices/Architecture.xml | 2 +- .../UnmanagedCallConvAttribute.xml | 2 +- xml/ns-System.Runtime.InteropServices.ObjectiveC.xml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/xml/System.Runtime.InteropServices/Architecture.xml b/xml/System.Runtime.InteropServices/Architecture.xml index cd35f21cf2b..aa376a4cf61 100644 --- a/xml/System.Runtime.InteropServices/Architecture.xml +++ b/xml/System.Runtime.InteropServices/Architecture.xml @@ -142,7 +142,7 @@ 5 - To be added. + The S390x platform architecture. diff --git a/xml/System.Runtime.InteropServices/UnmanagedCallConvAttribute.xml b/xml/System.Runtime.InteropServices/UnmanagedCallConvAttribute.xml index 006f355ecb1..18206ebf06d 100644 --- a/xml/System.Runtime.InteropServices/UnmanagedCallConvAttribute.xml +++ b/xml/System.Runtime.InteropServices/UnmanagedCallConvAttribute.xml @@ -37,7 +37,7 @@ - To be added. + Initializes a new instance. To be added. diff --git a/xml/ns-System.Runtime.InteropServices.ObjectiveC.xml b/xml/ns-System.Runtime.InteropServices.ObjectiveC.xml index 00bfa915bcf..b3c6a4ff5fc 100644 --- a/xml/ns-System.Runtime.InteropServices.ObjectiveC.xml +++ b/xml/ns-System.Runtime.InteropServices.ObjectiveC.xml @@ -1,6 +1,6 @@ - To be added. + Contains classes that support interoperation between managed code and the Objective-C Runtime. To be added. From 0a1a0bbb4871374e2c28eb23ec1203639f2dabe9 Mon Sep 17 00:00:00 2001 From: Aaron Robinson Date: Fri, 3 Sep 2021 16:00:31 -0700 Subject: [PATCH 2/4] Docs for MemoryMarshal and PosixSignalContext. --- xml/System.Runtime.InteropServices/MemoryMarshal.xml | 2 +- xml/System.Runtime.InteropServices/PosixSignalContext.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Runtime.InteropServices/MemoryMarshal.xml b/xml/System.Runtime.InteropServices/MemoryMarshal.xml index 0bba1f03524..b90de0ec092 100644 --- a/xml/System.Runtime.InteropServices/MemoryMarshal.xml +++ b/xml/System.Runtime.InteropServices/MemoryMarshal.xml @@ -682,7 +682,7 @@ This method can be useful if part of a managed object represents a fixed array. - To be added. + The array to analyze. Returns a reference to the 0th element of . If the array is empty, returns a reference to where the 0th element would have been stored. Such a reference may be used for pinning but must never be dereferenced. To be added. diff --git a/xml/System.Runtime.InteropServices/PosixSignalContext.xml b/xml/System.Runtime.InteropServices/PosixSignalContext.xml index eb679cd07a1..d71eec932aa 100644 --- a/xml/System.Runtime.InteropServices/PosixSignalContext.xml +++ b/xml/System.Runtime.InteropServices/PosixSignalContext.xml @@ -34,7 +34,7 @@ - To be added. + The signal that occurred. Initializes a new instance of the class. To be added. From a116e288a1c2419f5529a7e80f0f911fa8fe51f4 Mon Sep 17 00:00:00 2001 From: Aaron Robinson Date: Fri, 3 Sep 2021 16:03:53 -0700 Subject: [PATCH 3/4] Doc update for CollectionsMarshal --- xml/System.Runtime.InteropServices/CollectionsMarshal.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System.Runtime.InteropServices/CollectionsMarshal.xml b/xml/System.Runtime.InteropServices/CollectionsMarshal.xml index c273119809f..4399b257a0a 100644 --- a/xml/System.Runtime.InteropServices/CollectionsMarshal.xml +++ b/xml/System.Runtime.InteropServices/CollectionsMarshal.xml @@ -75,8 +75,8 @@ - To be added. - To be added. + The type of a key. + The type of a value. The dictionary to get the reference to from. The key used for lookup. When this method returns, contains if already existed in the dictionary, and if a new entry was added. @@ -117,8 +117,8 @@ Items should not be added to or removed from the - To be added. - To be added. + The type of a key. + The type of a value. The dictionary to get the ref to from. The key used for lookup. Gets either a ref to a in the or a ref if it does not exist in the . From 21f43d3479e91099b4df3ebb9e8d1d1d4976c2de Mon Sep 17 00:00:00 2001 From: Aaron Robinson Date: Fri, 3 Sep 2021 16:31:49 -0700 Subject: [PATCH 4/4] Update docs for Objective-C classes --- ...l+UnhandledExceptionPropagationHandler.xml | 2 +- .../ObjectiveCMarshal.xml | 23 ++++++++++++++----- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal+UnhandledExceptionPropagationHandler.xml b/xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal+UnhandledExceptionPropagationHandler.xml index 13678d1f52e..25aef008241 100644 --- a/xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal+UnhandledExceptionPropagationHandler.xml +++ b/xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal+UnhandledExceptionPropagationHandler.xml @@ -25,7 +25,7 @@ Last managed method. Context provided to the returned function pointer. Handler for unhandled Exceptions crossing the managed -> native boundary (that is, Reverse P/Invoke). - To be added. + Exception propagation callback. - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. + Called when tracking begins and ends. + Called to determine if a managed object instance is referenced elsewhere, and must not be collected by the GC. + Called when a tracked object enters the finalization queue. + Handler for the propagation of unhandled Exceptions across a managed -> native boundary (that is, Reverse P/Invoke). + Initialize the Objective-C marshalling API. + +All unmanaged function pointers must be written in native code since they will be called by the GC and +managed code is not able to run at that time. + +The will be called when reference tracking begins and ends. +The associated begin/end pair will never be nested. When using Workstation GC, the begin/end pair +will be called on the same thread. When using Server GC, the begin/end pair is not guaranteed to +be called on the same thread. + +The should return 0 for not reference or 1 for +referenced. Any other value has undefined behavior. +