2007-01-30 Paolo Bonzini <bonzini@gnu.org>

[bison.git] / src / symlist.h

diff --git a/src/symlist.h b/src/symlist.h
index 8bb95438c662604363aa2d996392f8a1a150621b..ab9a4b5eb0394819a99a75f234ff502d1a2f8069 100644 (file)
--- a/src/symlist.h
+++ b/src/symlist.h
@@ -1,6 +1,6 @@
 /* Lists of symbols for Bison
 
-   Copyright (C) 2002, 2005, 2006 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2005, 2006, 2007 Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
 
@@ -22,8 +22,8 @@
 #ifndef SYMLIST_H_
 # define SYMLIST_H_
 
-# include "scan-code.h"
 # include "location.h"
+# include "scan-code.h"
 # include "symtab.h"
 
 /* A list of symbols, used during the parsing to store the rules.  */
@@ -31,16 +31,21 @@ typedef struct symbol_list
 {
   /**
    * Whether this node contains a symbol, a semantic type, a \c <*>, or a
-   * \c <!>.
+   * \c <>.
    */
   enum {
     SYMLIST_SYMBOL, SYMLIST_TYPE,
     SYMLIST_DEFAULT_TAGGED, SYMLIST_DEFAULT_TAGLESS
   } content_type;
   union {
-    /** The symbol or \c NULL iff <tt>node_type = SYMLIST_SYMBOL</tt>.  */
+    /**
+     * The symbol or \c NULL iff
+     * <tt>symbol_list::content_type = SYMLIST_SYMBOL</tt>.
+     */
     symbol *sym;
-    /** The semantic type iff <tt>node_type = SYMLIST_TYPE</tt>.  */
+    /**
+     * The semantic type iff <tt>symbol_list::content_type = SYMLIST_TYPE</tt>.
+     */
     uniqstr type_name;
   } content;
   location location;
@@ -79,7 +84,7 @@ symbol_list *symbol_list_type_new (uniqstr type_name, location loc);
 
 /** Create a list containing a \c <*> at \c loc.  */
 symbol_list *symbol_list_default_tagged_new (location loc);
-/** Create a list containing a \c <!> at \c loc.  */
+/** Create a list containing a \c <> at \c loc.  */
 symbol_list *symbol_list_default_tagless_new (location loc);
 
 /** Print this list.
@@ -104,12 +109,12 @@ symbol_list *symbol_list_n_get (symbol_list *l, int n);
    symbol N in rule RULE.  */
 uniqstr symbol_list_n_type_name_get (symbol_list *l, location loc, int n);
 
-/** Set the \c \%destructor for \c node as \c destructor at \c loc.  */
-void symbol_list_destructor_set (symbol_list *node, const char *code,
+/** Set the \c \%destructor for \c node as \c code at \c loc.  */
+void symbol_list_destructor_set (symbol_list *node, char const *code,
                                  location loc);
 
-/** Set the \c \%printer for \c node as \c printer at \c loc.  */
-void symbol_list_printer_set (symbol_list *node, const char *code,
+/** Set the \c \%printer for \c node as \c code at \c loc.  */
+void symbol_list_printer_set (symbol_list *node, char const *code,
                               location loc);
 
 #endif /* !SYMLIST_H_ */