tests: make deprecation tests more specific

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index 9377800801e4d6bc793e6e622545de7d616a1e9a..09100f6a9c918f5295ab65859b423f80e5a976bd 100644 (file)
--- a/src/symtab.h
+++ b/src/symtab.h
@@ -54,13 +54,12 @@ typedef struct symbol symbol;
 /* Declaration status of a symbol.
 
    First, it is "undeclared".  Then, if "undeclared" and used in a
 /* Declaration status of a symbol.
 
    First, it is "undeclared".  Then, if "undeclared" and used in a

-   %printer/%destructor, it is "used".  If not "declared" by used in a
-   rule, it is "needed".  Finally, if declared (via a rule for
-   nonterminals, or %oken), it is "declared".
+   %printer/%destructor, it is "used".  If not "declared" but used in
+   a rule, it is "needed".  Finally, if declared (via a rule for
+   nonterminals, or %token), it is "declared".

 
    When status are checked at the end, "declared" symbols are fine,
 
    When status are checked at the end, "declared" symbols are fine,

-   "used" symbols trigger warnings, otherwise it's an error.
-*/
+   "used" symbols trigger warnings, otherwise it's an error.  */

 
 typedef enum
   {
 
 typedef enum
   {


@@ -92,8 +91,14 @@ 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;
 
   /** Its \c \%type's location.  */
   location type_location;
 


@@ -101,9 +106,9 @@ struct symbol
       symbol.
 
       Access this field only through <tt>symbol</tt>'s interface functions. For
       symbol.
 
       Access this field only through <tt>symbol</tt>'s interface functions. For

-      Example, if <tt>symbol::destructor = NULL</tt> (resp. <tt>symbol::printer
+      example, if <tt>symbol::destructor = NULL</tt> (resp. <tt>symbol::printer

       = NULL</tt>), a default \c \%destructor (resp. \%printer) or a per-type
       = NULL</tt>), a default \c \%destructor (resp. \%printer) or a per-type

-      \c symbol_destructor_printer_get will compute the corect one. */
+      \c symbol_destructor_printer_get will compute the correct one. */

   code_props props[CODE_PROPS_SIZE];
 
   symbol_number number;
   code_props props[CODE_PROPS_SIZE];
 
   symbol_number number;