merge from gcc

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

diff --git a/libiberty/insque.c b/libiberty/insque.c
index 775019f8fffc9bbd3bae8d04c1870d7e1caf190a..c0c1180d42115eb727dd35b7a687c635388c6c5b 100644 (file)
--- a/libiberty/insque.c
+++ b/libiberty/insque.c
@@ -2,24 +2,27 @@
    This file is in the public domain.  */
 
 /*
-NAME
-       insque, remque -- insert, remove an element from a queue
 
-SYNOPSIS
-       struct qelem {
-         struct qelem *q_forw;
-         struct qelem *q_back;
-         char q_data[];
-       };
+@deftypefn Supplemental void insque (struct qelem *@var{elem}, struct qelem *@var{pred})
+@deftypefnx Supplemental void remque (struct qelem *@var{elem})
 
-       void insque (struct qelem *elem, struct qelem *pred)
+Routines to manipulate queues built from doubly linked lists.  The
+@code{insque} routine inserts @var{elem} in the queue immediately
+after @var{pred}.  The @code{remque} routine removes @var{elem} from
+its containing queue.  These routines expect to be passed pointers to
+structures which have as their first members a forward pointer and a
+back pointer, like this prototype (although no prototype is provided):
 
-       void remque (struct qelem *elem)
+@example
+struct qelem @{
+  struct qelem *q_forw;
+  struct qelem *q_back;
+  char q_data[];
+@};
+@end example
+
+@end deftypefn
 
-DESCRIPTION
-       Routines to manipulate queues built from doubly linked lists.
-       The insque routine inserts ELEM in the queue immediately after
-       PRED.  The remque routine removes ELEM from its containing queue.
 */