*** empty log message ***

[deliverable/binutils-gdb.git] / libiberty / xatexit.c

diff --git a/libiberty/xatexit.c b/libiberty/xatexit.c
index 31476c29ddca36d2b037c26541147bd43c1a6805..728254b2c0d818bf54e6ae172ccf162d291716b8 100644 (file)
--- a/libiberty/xatexit.c
+++ b/libiberty/xatexit.c
@@ -5,6 +5,20 @@
  * %sccs.include.redist.c%
  */
 
+
+/*
+
+@deftypefun int xatexit (void (*@var{fn}) (void))
+
+Behaves as the standard @code{atexit} function, but with no limit on
+the number of registered functions.  Returns 0 on success, or @minus{}1 on
+failure.  If you use @code{xatexit} to register functions, you must use
+@code{xexit} to terminate your program.
+
+@end deftypefun
+
+*/
+
 /* Adapted from newlib/libc/stdlib/{,at}exit.[ch].
    If you use xatexit, you must call xexit instead of exit.  */