Fix Doxygen comment.

[bison.git] / data / bison.m4

diff --git a/data/bison.m4 b/data/bison.m4
index 5a5df0f3fb8584f85d18320df25db30c7c52b9ae..37bc012f58f9f1822cbba76389ccbc1255b751ce 100644 (file)
--- a/data/bison.m4
+++ b/data/bison.m4
@@ -1,7 +1,8 @@
                                                             -*- Autoconf -*-
 
 # Language-independent M4 Macros for Bison.
                                                             -*- Autoconf -*-
 
 # Language-independent M4 Macros for Bison.

-# Copyright (C) 2002, 2004-2010 Free Software Foundation, Inc.
+
+# Copyright (C) 2002, 2004-2012 Free Software Foundation, Inc.

 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by


@@ -87,7 +88,7 @@ m4_if(m4_sysval, [0], [], [m4_fatal([$0: cannot write to stdout])])])
 #
 # For example:
 #
 #
 # For example:
 #

-#   b4_error([[warn]], [[invalid value for `%s': %s]], [[foo]], [[3]])
+#   b4_error([[warn]], [[invalid value for '%s': %s]], [[foo]], [[3]])

 m4_define([b4_error],
 [b4_cat([[@]$1[(]$2[]]dnl
 [m4_if([$#], [2], [],
 m4_define([b4_error],
 [b4_cat([[@]$1[(]$2[]]dnl
 [m4_if([$#], [2], [],


@@ -116,7 +117,7 @@ m4_define([b4_error_at],
 #
 # For example:
 #
 #
 # For example:
 #

-#   b4_warn([[invalid value for `%s': %s]], [[foo]], [[3]])
+#   b4_warn([[invalid value for '%s': %s]], [[foo]], [[3]])

 #
 # As a simple test suite, this:
 #
 #
 # As a simple test suite, this:
 #


@@ -303,8 +304,8 @@ m4_define([b4_parser_tables_define],
 m4_define([b4_flag_if],
 [m4_case(b4_$1_flag,
          [0], [$3],
 m4_define([b4_flag_if],
 [m4_case(b4_$1_flag,
          [0], [$3],

-        [1], [$2],
-        [m4_fatal([invalid $1 value: ]$1)])])
+         [1], [$2],
+         [m4_fatal([invalid $1 value: ]$1)])])

 
 
 # b4_define_flag_if(FLAG)
 
 
 # b4_define_flag_if(FLAG)


@@ -329,10 +330,10 @@ m4_define([b4_$3_if],
 # b4_FLAG_if(IF-TRUE, IF-FALSE)
 # -----------------------------
 # Expand IF-TRUE, if FLAG is true, IF-FALSE otherwise.
 # b4_FLAG_if(IF-TRUE, IF-FALSE)
 # -----------------------------
 # Expand IF-TRUE, if FLAG is true, IF-FALSE otherwise.

-b4_define_flag_if([defines])           # Whether headers are requested.
-b4_define_flag_if([glr])               # Whether a GLR parser is requested.
-b4_define_flag_if([nondeterministic])  # Whether conflicts should be handled.
-b4_define_flag_if([yacc])              # Whether POSIX Yacc is emulated.
+b4_define_flag_if([defines])            # Whether headers are requested.
+b4_define_flag_if([glr])                # Whether a GLR parser is requested.
+b4_define_flag_if([nondeterministic])   # Whether conflicts should be handled.
+b4_define_flag_if([yacc])               # Whether POSIX Yacc is emulated.

 
 
 ## --------- ##
 
 
 ## --------- ##


@@ -434,7 +435,7 @@ m4_define([b4_type_action_],
         b4_dollar_dollar([b4_symbol([$1], [number])],
                          [b4_symbol([$1], [tag])],
                          [b4_symbol([$1], [type])]);
         b4_dollar_dollar([b4_symbol([$1], [number])],
                          [b4_symbol([$1], [tag])],
                          [b4_symbol([$1], [type])]);

-       break;
+        break;

 
 ])])
 
 
 ])])
 


@@ -541,7 +542,7 @@ m4_pushdef([b4_start], m4_car(m4_shift(b4_occurrence)))dnl
 m4_pushdef([b4_end], m4_shift(m4_shift(b4_occurrence)))dnl
 m4_ifndef($3[(]m4_quote(b4_user_name)[)],
           [b4_complain_at([b4_start], [b4_end],
 m4_pushdef([b4_end], m4_shift(m4_shift(b4_occurrence)))dnl
 m4_ifndef($3[(]m4_quote(b4_user_name)[)],
           [b4_complain_at([b4_start], [b4_end],

-                          [[%s `%s' is not used]],
+                          [[%s '%s' is not used]],

                           [$1], [b4_user_name])])[]dnl
 m4_popdef([b4_occurrence])dnl
 m4_popdef([b4_user_name])dnl
                           [$1], [b4_user_name])])[]dnl
 m4_popdef([b4_occurrence])dnl
 m4_popdef([b4_user_name])dnl


@@ -563,10 +564,11 @@ m4_define([b4_percent_define_use],
 [m4_define([b4_percent_define_bison_variables(]$1[)])dnl
 ])
 
 [m4_define([b4_percent_define_bison_variables(]$1[)])dnl
 ])
 

-# b4_percent_define_get(VARIABLE)
-# -------------------------------
-# Mimic muscle_percent_define_get in ../src/muscle-tab.h exactly.  That is, if
-# the %define variable VARIABLE is defined, emit its value.  Also, record
+# b4_percent_define_get(VARIABLE, [DEFAULT])
+# ------------------------------------------
+# Mimic muscle_percent_define_get in ../src/muscle-tab.h.  That is, if
+# the %define variable VARIABLE is defined, emit its value.  Contrary
+# to its C counterpart, return DEFAULT otherwise.  Also, record

 # Bison's usage of VARIABLE by defining
 # b4_percent_define_bison_variables(VARIABLE).
 #
 # Bison's usage of VARIABLE by defining
 # b4_percent_define_bison_variables(VARIABLE).
 #


@@ -575,7 +577,9 @@ m4_define([b4_percent_define_use],
 #   b4_percent_define_get([[foo]])
 m4_define([b4_percent_define_get],
 [b4_percent_define_use([$1])dnl
 #   b4_percent_define_get([[foo]])
 m4_define([b4_percent_define_get],
 [b4_percent_define_use([$1])dnl

-m4_ifdef([b4_percent_define(]$1[)], [m4_indir([b4_percent_define(]$1[)])])])
+m4_ifdef([b4_percent_define(]$1[)],
+         [m4_indir([b4_percent_define(]$1[)])],
+         [$2])])

 
 # b4_percent_define_get_loc(VARIABLE)
 # -----------------------------------
 
 # b4_percent_define_get_loc(VARIABLE)
 # -----------------------------------


@@ -594,7 +598,7 @@ m4_define([b4_percent_define_get_loc],
           [m4_pushdef([b4_loc], m4_indir([b4_percent_define_loc(]$1[)]))dnl
 b4_loc[]dnl
 m4_popdef([b4_loc])],
           [m4_pushdef([b4_loc], m4_indir([b4_percent_define_loc(]$1[)]))dnl
 b4_loc[]dnl
 m4_popdef([b4_loc])],

-          [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_get_loc]], [$1])])])
+          [b4_fatal([[b4_percent_define_get_loc: undefined %%define variable '%s']], [$1])])])

 
 # b4_percent_define_get_syncline(VARIABLE)
 # ----------------------------------------
 
 # b4_percent_define_get_syncline(VARIABLE)
 # ----------------------------------------


@@ -611,7 +615,7 @@ m4_popdef([b4_loc])],
 m4_define([b4_percent_define_get_syncline],
 [m4_ifdef([b4_percent_define_syncline(]$1[)],
           [m4_indir([b4_percent_define_syncline(]$1[)])],
 m4_define([b4_percent_define_get_syncline],
 [m4_ifdef([b4_percent_define_syncline(]$1[)],
           [m4_indir([b4_percent_define_syncline(]$1[)])],

-          [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_get_syncline]], [$1])])])
+          [b4_fatal([[b4_percent_define_get_syncline: undefined %%define variable '%s']], [$1])])])

 
 # b4_percent_define_ifdef(VARIABLE, IF-TRUE, [IF-FALSE])
 # ------------------------------------------------------
 
 # b4_percent_define_ifdef(VARIABLE, IF-TRUE, [IF-FALSE])
 # ------------------------------------------------------


@@ -625,8 +629,8 @@ m4_define([b4_percent_define_get_syncline],
 #   b4_percent_define_ifdef([[foo]], [[it's defined]], [[it's undefined]])
 m4_define([b4_percent_define_ifdef],
 [m4_ifdef([b4_percent_define(]$1[)],
 #   b4_percent_define_ifdef([[foo]], [[it's defined]], [[it's undefined]])
 m4_define([b4_percent_define_ifdef],
 [m4_ifdef([b4_percent_define(]$1[)],

-         [b4_percent_define_use([$1])$2],
-         [$3])])
+          [b4_percent_define_use([$1])$2],
+          [$3])])

 
 
 ## --------- ##
 
 
 ## --------- ##


@@ -652,10 +656,10 @@ m4_define([b4_percent_define_flag_if],
   [m4_case(b4_percent_define_get([$1]),
            [], [$2], [true], [$2], [false], [$3],
            [m4_expand_once([b4_complain_at(b4_percent_define_get_loc([$1]),
   [m4_case(b4_percent_define_get([$1]),
            [], [$2], [true], [$2], [false], [$3],
            [m4_expand_once([b4_complain_at(b4_percent_define_get_loc([$1]),

-                                           [[invalid value for %%define Boolean variable `%s']],
+                                           [[invalid value for %%define Boolean variable '%s']],

                                            [$1])],
                            [[b4_percent_define_flag_if($1)]])])],
                                            [$1])],
                            [[b4_percent_define_flag_if($1)]])])],

-  [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_flag_if]], [$1])])])
+  [b4_fatal([[b4_percent_define_flag_if: undefined %%define variable '%s']], [$1])])])

 
 
 # b4_percent_define_default(VARIABLE, DEFAULT)
 
 
 # b4_percent_define_default(VARIABLE, DEFAULT)


@@ -719,15 +723,15 @@ m4_define([_b4_percent_define_check_values],
                             [m4_define([b4_good_value], [1])])])])dnl
    m4_if(b4_good_value, [0],
          [b4_complain_at(b4_percent_define_get_loc([$1]),
                             [m4_define([b4_good_value], [1])])])])dnl
    m4_if(b4_good_value, [0],
          [b4_complain_at(b4_percent_define_get_loc([$1]),

-                         [[invalid value for %%define variable `%s': `%s']],
+                         [[invalid value for %%define variable '%s': '%s']],

                          [$1],
                          m4_dquote(m4_indir([b4_percent_define(]$1[)])))
           m4_foreach([b4_value], m4_dquote(m4_shift($@)),
                      [b4_complain_at(b4_percent_define_get_loc([$1]),
                          [$1],
                          m4_dquote(m4_indir([b4_percent_define(]$1[)])))
           m4_foreach([b4_value], m4_dquote(m4_shift($@)),
                      [b4_complain_at(b4_percent_define_get_loc([$1]),

-                                     [[accepted value: `%s']],
+                                     [[accepted value: '%s']],

                                      m4_dquote(b4_value))])])dnl
    m4_popdef([b4_good_value])],
                                      m4_dquote(b4_value))])])dnl
    m4_popdef([b4_good_value])],

-  [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_check_values]], [$1])])])
+  [b4_fatal([[b4_percent_define_check_values: undefined %%define variable '%s']], [$1])])])

 
 # b4_percent_code_get([QUALIFIER])
 # --------------------------------
 
 # b4_percent_code_get([QUALIFIER])
 # --------------------------------


@@ -761,7 +765,7 @@ m4_popdef([b4_macro_name])])
 m4_define([b4_percent_code_ifdef],
 [m4_ifdef([b4_percent_code(]$1[)],
           [m4_ifval([$1], [m4_define([b4_percent_code_bison_qualifiers(]$1[)])])$2],
 m4_define([b4_percent_code_ifdef],
 [m4_ifdef([b4_percent_code(]$1[)],
           [m4_ifval([$1], [m4_define([b4_percent_code_bison_qualifiers(]$1[)])])$2],

-         [$3])])
+          [$3])])

 
 
 ## ------------------ ##
 
 
 ## ------------------ ##