regen

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index db902e757a90f5589092ed859e849e4f10439396..7d8cf982650f36ff71f829976388eaa23a7563dd 100644 (file)
--- a/src/symtab.h
+++ b/src/symtab.h
@@ -60,23 +60,30 @@ struct symbol
   /** The location of its first occurrence.  */
   location location;
 
   /** The location of its first occurrence.  */
   location location;
 

-  /** Its \c \%type.  */
+  /** Its \c \%type.
+
+      Beware that this is the type_name as was entered by the user,
+      including silly things such as "]" if she entered "%token <]> t".
+      Therefore, when outputting type_name to M4, be sure to escape it
+      into "@}".  See quoted_output for instance.  */

   uniqstr type_name;
   uniqstr type_name;

+

   /** Its \c \%type's location.  */
   location type_location;
 
   /** Any \c \%destructor declared specifically for this symbol.
 
   /** Its \c \%type's location.  */
   location type_location;
 
   /** Any \c \%destructor declared specifically for this symbol.
 

-     Access this field only through <tt>symbol</tt>'s interface functions.  For
-     example, if <tt>symbol::destructor = NULL</tt>, a default \c \%destructor
-     or a per-type \c \%destructor might be appropriate, and
-     \c symbol_destructor_get will compute the correct one.  */
+      Access this field only through <tt>symbol</tt>'s interface
+      functions.  For example, if <tt>symbol::destructor = NULL</tt>, a
+      default \c \%destructor or a per-type \c \%destructor might be
+      appropriate, and \c symbol_destructor_get will compute the
+      correct one.  */

   code_props destructor;
 
   /** Any \c \%printer declared specifically for this symbol.
 
   code_props destructor;
 
   /** Any \c \%printer declared specifically for this symbol.
 

-     Access this field only through <tt>symbol</tt>'s interface functions.
-     \sa symbol::destructor  */
+      Access this field only through <tt>symbol</tt>'s interface functions.
+      \sa symbol::destructor  */

   code_props printer;
 
   symbol_number number;
   code_props printer;
 
   symbol_number number;