Breakpad DWARF parser: Fix up documentation for DWARF reader classes.

Fix typos.

For CompilationUnit::Start, I was confused by the '-' in the original
comment, taking it for a parenthetic clause marker, assuming an
implicit "of the next compilation unit" at the end of the sentence.

The comments should refer to the ".debug_info" section, not the
"debug_info" section. The latter is not the section name actually used
on any system (ELF or Mach-O), and the former is the name prescribed
by the DWARF spec.

Some of the comments for ProcessAttribute* member functions claim that
OFFSET is from the start of the compilation unit, but that's not so:
the code has always passed an offset relative to the start of the
.debug_info section.

a=jimblandy, r=nealsid


git-svn-id: http://google-breakpad.googlecode.com/svn/trunk@453 4c0a9323-5329-0410-9bdc-e9ce6186880e

1 files changed, 4 insertions, 4 deletions

diff --git a/src/common/dwarf/functioninfo.h b/src/common/dwarf/functioninfo.h
index ad42ec74..740f1463 100644
--- a/src/common/dwarf/functioninfo.h
+++ b/src/common/dwarf/functioninfo.h
@@ -125,7 +125,7 @@ class CUFunctionInfoHandler: public Dwarf2Handler {
   virtual ~CUFunctionInfoHandler() { }
 
   // Start to process a compilation unit at OFFSET from the beginning of the
-  // debug_info section.  We want to see all compilation units, so we
+  // .debug_info section.  We want to see all compilation units, so we
   // always return true.
 
   virtual bool StartCompilationUnit(uint64 offset, uint8 address_size,
@@ -133,13 +133,13 @@ class CUFunctionInfoHandler: public Dwarf2Handler {
                                     uint8 dwarf_version);
 
   // Start to process a DIE at OFFSET from the beginning of the
-  // debug_info section.  We only care about function related DIE's.
+  // .debug_info section.  We only care about function related DIE's.
   virtual bool StartDIE(uint64 offset, enum DwarfTag tag,
                         const AttributeList& attrs);
 
   // Called when we have an attribute with unsigned data to give to
   // our handler.  The attribute is for the DIE at OFFSET from the
-  // beginning of compilation unit, has a name of ATTR, a form of
+  // beginning of the .debug_info section, has a name of ATTR, a form of
   // FORM, and the actual data of the attribute is in DATA.
   virtual void ProcessAttributeUnsigned(uint64 offset,
                                         enum DwarfAttribute attr,
@@ -148,7 +148,7 @@ class CUFunctionInfoHandler: public Dwarf2Handler {
 
   // Called when we have an attribute with string data to give to
   // our handler.  The attribute is for the DIE at OFFSET from the
-  // beginning of compilation unit, has a name of ATTR, a form of
+  // beginning of the .debug_info section, has a name of ATTR, a form of
   // FORM, and the actual data of the attribute is in DATA.
   virtual void ProcessAttributeString(uint64 offset,
                                       enum DwarfAttribute attr,