diff options
| author | jimblandy <jimblandy@4c0a9323-5329-0410-9bdc-e9ce6186880e> | 2010-02-09 17:10:57 +0000 |
|---|---|---|
| committer | jimblandy <jimblandy@4c0a9323-5329-0410-9bdc-e9ce6186880e> | 2010-02-09 17:10:57 +0000 |
| commit | c50e7c604cd1b12bba9421b0a95357fc942ecd7c (patch) | |
| tree | 04bb8865b5b3a065d69b843cf904027b5d3c19b7 /src/common/linux/stabs_reader.h | |
| parent | Breakpad: Update copyright notice years on all files changed in 2010. (diff) | |
| download | breakpad-c50e7c604cd1b12bba9421b0a95357fc942ecd7c.tar.xz | |
Breakpad Linux dumper: Add file comments as required by the style guide.
This also includes some comments I promised Cary Coutant I'd write
about the appropriateness of processing attributes in EndAttributes
calls.
The Google C++ Style Guide requires each file to have an author notice
and a comment explaining the file's general purpose. For the record, I
don't think putting an author notice on the files is a good idea; it's
odd to have the original author retain prominence even if the file has
been heavily edited by others; the version control system answers this
question more accurately. This is only for Style Guide compliance. The
Apache group decided to discourage author annotations, partially for
these reasons:
http://mail-archives.apache.org/mod_mbox/jakarta-jmeter-dev/200402.mbox/%3C4039F65E.7020406@atg.com%3E
a=jimblandy, r=nealsid
git-svn-id: http://google-breakpad.googlecode.com/svn/trunk@518 4c0a9323-5329-0410-9bdc-e9ce6186880e
Diffstat (limited to 'src/common/linux/stabs_reader.h')
| -rw-r--r-- | src/common/linux/stabs_reader.h | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/src/common/linux/stabs_reader.h b/src/common/linux/stabs_reader.h index 098b50ae..5cfcdfb5 100644 --- a/src/common/linux/stabs_reader.h +++ b/src/common/linux/stabs_reader.h @@ -28,15 +28,20 @@ // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -// This file contains definitions related to the STABS reader and -// its handler interfaces. -// A description of the STABS debugging format can be found at -// http://sourceware.org/gdb/current/onlinedocs/stabs_toc.html +// Original author: Jim Blandy <jimb@mozilla.com> <jimb@red-bean.com> + +// stabs_reader.h: Define StabsReader, a parser for STABS debugging +// information. A description of the STABS debugging format can be +// found at: +// +// http://sourceware.org/gdb/current/onlinedocs/stabs_toc.html +// // The comments here assume you understand the format. // -// This reader assumes that the system's <a.out.h> and <stab.h> +// This parser assumes that the system's <a.out.h> and <stab.h> // headers accurately describe the layout of the STABS data; this code -// is not cross-platform safe. +// will not parse STABS data for a system with a different address +// size or endianness. #ifndef COMMON_LINUX_STABS_READER_H__ #define COMMON_LINUX_STABS_READER_H__ |