diff options
| author | Ivan Maidanski <ivmai@mail.ru> | 2022-01-18 10:04:29 +0300 |
|---|---|---|
| committer | Ivan Maidanski <ivmai@mail.ru> | 2022-01-18 10:04:29 +0300 |
| commit | 46cca81da54c8e6d61e5e464b581d0595f9f4917 (patch) | |
| tree | 72199da9433556122fff9fe59f337e90111daab3 /include/gc | |
| parent | c97fdcc2e9eb445d65916a519dc53f82f5059f0f (diff) | |
| download | bdwgc-46cca81da54c8e6d61e5e464b581d0595f9f4917.tar.gz | |
Document argument of GC_is_marked in gc_mark.h
* include/gc/gc_mark.h (GC_is_marked, GC_clear_mark_bit,
GC_set_mark_bit): Document the argument (copy from debugging.md).
Diffstat (limited to 'include/gc')
| -rw-r--r-- | include/gc/gc_mark.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/include/gc/gc_mark.h b/include/gc/gc_mark.h index 6ff8ceec..84fb427c 100644 --- a/include/gc/gc_mark.h +++ b/include/gc/gc_mark.h @@ -282,8 +282,10 @@ typedef void (GC_CALLBACK * GC_start_callback_proc)(void); GC_API void GC_CALL GC_set_start_callback(GC_start_callback_proc); GC_API GC_start_callback_proc GC_CALL GC_get_start_callback(void); -/* Slow/general mark bit manipulation. The caller must hold the */ -/* allocation lock. GC_is_marked returns 1 (TRUE) or 0. */ +/* Slow/general mark bit manipulation. The caller should hold the */ +/* allocation lock. GC_is_marked returns 1 (TRUE) or 0. The argument */ +/* should be the real address of an object (i.e. the address of the */ +/* debug header if there is one). */ GC_API int GC_CALL GC_is_marked(const void *) GC_ATTR_NONNULL(1); GC_API void GC_CALL GC_clear_mark_bit(const void *) GC_ATTR_NONNULL(1); GC_API void GC_CALL GC_set_mark_bit(const void *) GC_ATTR_NONNULL(1); |