aboutsummaryrefslogtreecommitdiff
path: root/src/common
diff options
context:
space:
mode:
authorjimblandy@gmail.com <jimblandy@gmail.com@4c0a9323-5329-0410-9bdc-e9ce6186880e>2009-08-07 22:11:32 +0000
committerjimblandy@gmail.com <jimblandy@gmail.com@4c0a9323-5329-0410-9bdc-e9ce6186880e>2009-08-07 22:11:32 +0000
commitd4a212a099b5c658a7e8a9b9df1dd6ff62e2b470 (patch)
tree41b96aa26797d9c0020e5a5d2f7d7fee35ad98b3 /src/common
parentLinux dumper: Move the data structures representing the breakpad data into th... (diff)
downloadbreakpad-d4a212a099b5c658a7e8a9b9df1dd6ff62e2b470.tar.xz
Linux dumper: fix comments in src/common/linux/module.h
Fix some typos and references to member functions that didn't make the final cut. a=jimblandy r=nealsid git-svn-id: http://google-breakpad.googlecode.com/svn/trunk@381 4c0a9323-5329-0410-9bdc-e9ce6186880e
Diffstat (limited to 'src/common')
-rw-r--r--src/common/linux/module.h28
1 files changed, 15 insertions, 13 deletions
diff --git a/src/common/linux/module.h b/src/common/linux/module.h
index f3a6c199..b91c0f90 100644
--- a/src/common/linux/module.h
+++ b/src/common/linux/module.h
@@ -133,28 +133,30 @@ class Module {
void AddFunctions(vector<Function *>::iterator begin,
vector<Function *>::iterator end);
- // If this module has a file named NAME, return a pointer to a
- // pointer to it. If it has none, then create one and return a
- // pointer to the new file.
- // Destroying this module frees all File objects that have been created
- // using this function, or with Insert.
+ // If this module has a file named NAME, return a pointer to it. If
+ // it has none, then create one and return a pointer to the new
+ // file. Destroying this module frees all File objects that have
+ // been created using this function, or with Insert.
File *FindFile(const string &name);
File *FindFile(const char *name);
// Write this module to STREAM in the breakpad symbol format.
// Return true if all goes well, or false if an error occurs. This
- // method writes out a header based on the values given to the
- // constructor, writes the source files added via Insert and
- // FindFile, and then the functions added via Insert, along with
- // their lines.
+ // method writes out:
+ // - a header based on the values given to the constructor,
+ // - the source files added via FindFile, and finally
+ // - the functions added via AddFunctions, each with its lines.
+ // Addresses in the output are all relative to the load address
+ // established by SetLoadAddress.
bool Write(FILE *stream);
private:
- // Assign source id numbers to this modules' files that functions'
- // line number data actually refers to. Set the source id numbers
- // for all other files to -1. We do this before writing out the
- // symbol file, omitting any unused files.
+ // Find those files in this module that are actually referred to by
+ // functions' line number data, and assign them source id numbers.
+ // Set the source id numbers for all other files --- unused by the
+ // source line data --- to -1. We do this before writing out the
+ // symbol file, at which point we omit any unused files.
void AssignSourceIds();
// Report an error that has occurred writing the symbol file, using