Provide an additional sub-message for clarity.

[bison.git] / src / named-ref.h

diff --git a/src/named-ref.h b/src/named-ref.h
index 9100296fdfb7ae4e4e13e4116437139356cd780a..82b24fd0e4b6cfe330e8dd59e47e5b09c28c6906 100644 (file)
--- a/src/named-ref.h
+++ b/src/named-ref.h
@@ -1,6 +1,6 @@
 /* Named symbol references for Bison
 
-   Copyright 2009 Free Software Foundation, Inc.
+   Copyright (C) 2009 Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
 
@@ -20,19 +20,24 @@
 #ifndef NAMED_REF_H_
 # define NAMED_REF_H_
 
-#include "uniqstr.h"
 #include "location.h"
+#include "uniqstr.h"
 
-typedef struct named_ref named_ref;
-
-struct named_ref
+/* Named reference object. Keeps information about
+   a symbolic name of a symbol in a rule. */
+typedef struct named_ref
 {
+  /* Symbolic named given by user. */
   uniqstr id;
+
+  /* Location of the symbolic name. Not including brackets. */
   location loc;
-};
+} named_ref;
 
+/* Allocate a named reference object. */
 named_ref *named_ref_new (uniqstr id, location loc);
 
+/* Free a named reference object. */
 void named_ref_free (named_ref *r);
 
 #endif /* !NAMED_REF_H_ */