From: Andrew Au <andrewau@microsoft.com>
Date: Fri, 10 Aug 2018 17:44:36 +0000 (-0700)
Subject: More API comments
X-Git-Tag: submit/tizen/20210909.063632~11030^2~3460
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a8da7144bea5ed12fdbabda69d518ef62eff7245;p=platform%2Fupstream%2Fdotnet%2Fruntime.git

More API comments


Commit migrated from https://github.com/dotnet/coreclr/commit/2015a6266ee239267997017bebaadb025ccd223b
---

diff --git a/src/coreclr/src/debug/inc/dacdbiinterface.h b/src/coreclr/src/debug/inc/dacdbiinterface.h
index abbe7d9..bd532a7 100644
--- a/src/coreclr/src/debug/inc/dacdbiinterface.h
+++ b/src/coreclr/src/debug/inc/dacdbiinterface.h
@@ -2696,7 +2696,17 @@ public:
     virtual
         HRESULT GetILCodeVersionNodeData(VMPTR_ILCodeVersionNode ilCodeVersionNode, DacSharedReJitInfo* pData) = 0;
 
-    // TODO, andrewau, documentation
+    // Enable or disable the GC notification events. The GC notification events are turned off by default
+    // They will be delivered through ICorDebugManagedCallback4
+    // 
+    // 
+    // Arguments:
+    //    fEnable - true to enable the events, false to disable
+    //
+    // Returns:
+    //    S_OK if no error
+    //    error HRESULTs such as CORDBG_READ_VIRTUAL_FAILURE are possible
+    // 
     virtual
         HRESULT EnableGCNotificationEvents(BOOL fEnable) = 0;