* aoutx.h, archive.c, archures.c, bfd.c, cache.c, coff-m88k.c,

	 coffcode.h, core.c, ctor.c, elf.c, format.c, ieee.c, init.c,
	 libbfd.c, libbfd.h, libcoff.h, opncls.c, reloc.c, section.c,
	 srec.c, syms.c, targets.c : all new documentation and lint
	 removal.

1 files changed, 24 insertions, 24 deletions

diff --git a/bfd/libcoff.h b/bfd/libcoff.h
index b666e2e..94a5664 100644
--- a/bfd/libcoff.h
+++ b/bfd/libcoff.h
@@ -35,26 +35,6 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #define obj_symbol_slew(bfd) 0
 #endif
 
-#if 0
-typedef struct coff_ptr_struct
-{
-  unsigned int offset;
-  char fix_tag;
-  char fix_end;
-  union {
-    union internal_auxent auxent;
-    struct internal_syment syment;
-  } u;
-} combined_entry_type;
-
-
-typedef struct 
-{
-  asymbol symbol;
-  combined_entry_type *native;
-  struct lineno_cache_entry *lineno;
-} coff_symbol_type;
-#endif
 
 /* `Tdata' information kept for COFF files.  */
 
@@ -93,23 +73,43 @@ typedef struct coff_tdata
 
 
 
-/*THE FOLLOWING IS EXTRACTED FROM THE SOURCE*/
+/* And more taken from the source .. */
 
-/*:coffcode.h*/
-typedef struct coff_ptr_struct 
 {
+
+        /* Remembers the offset from the first symbol in the file for
+          this symbol. Generated by coff_renumber_symbols. */
 unsigned int offset;
+
+        /* Should the tag field of this symbol be renumbered.
+          Created by coff_pointerize_aux. */
 char fix_tag;
+
+        /* Should the endidx field of this symbol be renumbered.
+          Created by coff_pointerize_aux. */
 char fix_end;
+
+        /* The container for the symbol structure as read and translated
+           from the file. */
+
 union {
    union internal_auxent auxent;
    struct internal_syment syment;
  } u;
 } combined_entry_type;
+
+
+ /* Each canonical asymbol really looks like this: */
+
 typedef struct coff_symbol_struct
 {
+    /* The actual symbol which the rest of BFD works with */
 asymbol symbol;
+
+    /* A pointer to the hidden information for this symbol */
 combined_entry_type *native;
+
+    /* A pointer to the linenumber information for this symbol */
 struct lineno_cache_entry *lineno;
-} coff_symbol_type;
 
+} coff_symbol_type;