]> granicus.if.org Git - gc/commitdiff
Fix return type in GC_set_warn_proc API documentation
authorIvan Maidanski <ivmai@mail.ru>
Tue, 15 May 2018 07:47:18 +0000 (10:47 +0300)
committerIvan Maidanski <ivmai@mail.ru>
Tue, 15 May 2018 08:25:49 +0000 (11:25 +0300)
(fix of commit 2dd4ee71d)

* doc/gcinterface.md: Change GC_set_warn_proc return type from
GC_warn_proc to void.

doc/gcinterface.md

index 43efec179401200bd6eb00ec8d42b76a60fdd4ff..4e7d309b7825f35b933f0bbae72e594618a3d5a2 100644 (file)
@@ -94,8 +94,8 @@ either has suitable support in the garbage collector (Linux and most Unix
 versions, Win32 if the collector was suitably built). On many platforms this
 interacts poorly with system calls that write to the garbage collected heap.
 
-**`GC_warn_proc GC_set_warn_proc(GC_warn_proc)`** - Replace the default
-procedure used by the collector to print warnings. The collector may otherwise
+**void `GC_set_warn_proc`(GC_warn_proc)** - Replace the default procedure
+used by the collector to print warnings. The collector may otherwise
 write to `stderr`, most commonly because `GC_malloc` was used in a situation
 in which `GC_malloc_ignore_off_page` would have been more appropriate. See
 `gc.h` for details.