[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 02/11] style: comment changes
From: |
Akim Demaille |
Subject: |
[PATCH 02/11] style: comment changes |
Date: |
Thu, 4 Apr 2013 17:36:19 +0200 |
* src/muscle-tab.c: Move the documentation of public functions to...
* src/muscle-tab.h: here.
Fix comment consistency issues.
---
src/muscle-tab.c | 31 -------------------------------
src/muscle-tab.h | 21 ++++++++++++++++++---
2 files changed, 18 insertions(+), 34 deletions(-)
diff --git a/src/muscle-tab.c b/src/muscle-tab.c
index 8060a2c..c4f302c 100644
--- a/src/muscle-tab.c
+++ b/src/muscle-tab.c
@@ -60,11 +60,6 @@ hash_muscle (const void *x, size_t tablesize)
return hash_string (m->key, tablesize);
}
-/*-----------------------------------------------------------------.
-| Create the MUSCLE_TABLE, and initialize it with default values. |
-| Also set up the MUSCLE_OBSTACK. |
-`-----------------------------------------------------------------*/
-
static void
muscle_entry_free (void *entry)
{
@@ -87,10 +82,6 @@ muscle_init (void)
}
-/*------------------------------------------------------------.
-| Free all the memory consumed by the muscle machinery only. |
-`------------------------------------------------------------*/
-
void
muscle_free (void)
{
@@ -99,12 +90,6 @@ muscle_free (void)
}
-
-/*------------------------------------------------------------.
-| Insert (KEY, VALUE). If KEY already existed, overwrite the |
-| previous value. |
-`------------------------------------------------------------*/
-
void
muscle_insert (char const *key, char const *value)
{
@@ -212,11 +197,6 @@ void muscle_pair_list_grow (const char *muscle,
}
-/*----------------------------------------------------------------------------.
-| Find the value of muscle KEY. Unlike MUSCLE_FIND, this is always reliable |
-| to determine whether KEY has a value. |
-`----------------------------------------------------------------------------*/
-
char const *
muscle_find_const (char const *key)
{
@@ -231,12 +211,6 @@ muscle_find_const (char const *key)
}
-/*----------------------------------------------------------------------------.
-| Find the value of muscle KEY. Abort if muscle_insert was invoked more |
-| recently than muscle_grow for KEY since muscle_find can't return a |
-| char const *. |
-`----------------------------------------------------------------------------*/
-
char *
muscle_find (char const *key)
{
@@ -711,11 +685,6 @@ muscle_m4_output_processor (void *entry, void *out)
}
-/*----------------------------------------------------------------.
-| Output the definition of all the current muscles into a list of |
-| m4_defines. |
-`----------------------------------------------------------------*/
-
void
muscles_m4_output (FILE *out)
{
diff --git a/src/muscle-tab.h b/src/muscle-tab.h
index 59c8751..30a7452 100644
--- a/src/muscle-tab.h
+++ b/src/muscle-tab.h
@@ -24,10 +24,24 @@
# include "location.h"
+/* Create the MUSCLE_TABLE, and initialize it with default values.
+ Also set up the MUSCLE_OBSTACK. */
void muscle_init (void);
+
+/* Insert (KEY, VALUE). If KEY already existed, overwrite the
+ previous value. */
void muscle_insert (char const *key, char const *value);
+
+/* Find the value of muscle KEY. Unlike MUSCLE_FIND, this is always
+ reliable to determine whether KEY has a value. */
char const *muscle_find_const (char const *key);
+
+/* Find the value of muscle KEY. Abort if muscle_insert was invoked
+ more recently than muscle_grow for KEY since muscle_find can't
+ return a char const *. */
char *muscle_find (char const *key);
+
+/* Free all the memory consumed by the muscle machinery only. */
void muscle_free (void);
@@ -71,13 +85,11 @@ extern struct obstack muscle_obstack;
/* Append VALUE to the current value of KEY. If KEY did not already
exist, create it. Use MUSCLE_OBSTACK. De-allocate the previously
associated value. Copy VALUE and SEPARATOR. */
-
void muscle_grow (const char *key, const char *value, const char *separator);
/* Append VALUE to the current value of KEY, using muscle_grow. But
in addition, issue a synchronization line for the location LOC. */
-
void muscle_code_grow (const char *key, const char *value, location loc);
@@ -97,7 +109,8 @@ void muscle_user_name_list_grow (char const *key, char const
*user_name,
/* Indicates whether a variable's value was specified with -D/--define, with
-F/--force-define, or in the grammar file. */
typedef enum {
- MUSCLE_PERCENT_DEFINE_D = 0, MUSCLE_PERCENT_DEFINE_F,
+ MUSCLE_PERCENT_DEFINE_D = 0,
+ MUSCLE_PERCENT_DEFINE_F,
MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
} muscle_percent_define_how;
@@ -184,6 +197,8 @@ void muscle_percent_define_check_values (char const * const
*values);
void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
char const *code, location code_loc);
+/* Output the definition of all the current muscles into a list of
+ m4_defines. */
void muscles_m4_output (FILE *out);
#endif /* not MUSCLE_TAB_H_ */
--
1.8.2
- [PATCH 00/11] support "%define variable {value}", Akim Demaille, 2013/04/04
- [PATCH 05/11] grammar: style changes, Akim Demaille, 2013/04/04
- [PATCH 07/11] style: fix comments, Akim Demaille, 2013/04/04
- [PATCH 11/11] api.namespace: demonstrate and use {...} values instead of "..." values, Akim Demaille, 2013/04/04
- [PATCH 04/11] grammar: split %union to group together related aspects, Akim Demaille, 2013/04/04
- [PATCH 02/11] style: comment changes,
Akim Demaille <=
- [PATCH 08/11] grammar: record the kind of %define variable values, Akim Demaille, 2013/04/04
- [PATCH 01/11] muscle: minor refactoring, Akim Demaille, 2013/04/04
- [PATCH 10/11] grammar: do not add a \n at the end of blocks of code, Akim Demaille, 2013/04/04
- [PATCH 03/11] muscle: refactor, Akim Demaille, 2013/04/04
- [PATCH 09/11] regen, Akim Demaille, 2013/04/04
- [PATCH 06/11] regen, Akim Demaille, 2013/04/04
- Re: [PATCH 00/11] support "%define variable {value}", Joel E. Denny, 2013/04/07
- Re: [PATCH 00/11] support "%define variable {value}", Akim Demaille, 2013/04/09