2004-12-15 H.J. Lu <hongjiu.lu@intel.com>

[pf3gnuchains/gcc-fork.git] / libiberty / index.c

diff --git a/libiberty/index.c b/libiberty/index.c
index e5a00f5..a2e2727 100644 (file)
--- a/libiberty/index.c
+++ b/libiberty/index.c
@@ -1,5 +1,17 @@
 /* Stub implementation of (obsolete) index(). */
 
+/*
+
+@deftypefn Supplemental char* index (char *@var{s}, int @var{c})
+
+Returns a pointer to the first occurrence of the character @var{c} in
+the string @var{s}, or @code{NULL} if not found.  The use of @code{index} is
+deprecated in new programs in favor of @code{strchr}.
+
+@end deftypefn
+
+*/
+
 extern char * strchr();
 
 char *