diff options
| author | Daniel Brahneborg <basic@chello.se> | 2002-03-06 20:03:48 +0000 |
|---|---|---|
| committer | Daniel Brahneborg <basic@chello.se> | 2002-03-06 20:03:48 +0000 |
| commit | c989ceb038fcfe5d583928dfd1f8b0cf6a301cbe (patch) | |
| tree | a938f3d1e5123e1505a4fd3840c3182f8d6395ee /lib/sisfileheader.h | |
| parent | aa59faec168326365c6bdc6743dffec336862a6a (diff) | |
| download | plptools-c989ceb038fcfe5d583928dfd1f8b0cf6a301cbe.tar.gz plptools-c989ceb038fcfe5d583928dfd1f8b0cf6a301cbe.tar.bz2 plptools-c989ceb038fcfe5d583928dfd1f8b0cf6a301cbe.zip | |
Document most of the method arguments with @param.
Diffstat (limited to 'lib/sisfileheader.h')
| -rw-r--r-- | lib/sisfileheader.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/lib/sisfileheader.h b/lib/sisfileheader.h index eba4c97..6b5fa3f 100644 --- a/lib/sisfileheader.h +++ b/lib/sisfileheader.h @@ -26,7 +26,10 @@ #include "sistypes.h" /** - * The first part of a SIS file. + * The first part of a SISFile. + * + * This file header is referenced from most other parts of the sis file, + * mainly since it contains the list of languages. */ class SISFileHeader { @@ -34,6 +37,11 @@ public: /** * Populate the fields. + * + * @param buf The buffer to read from. + * @param base The index to start reading from, which is updated + * when the header is successfully read. + * @param len The length of the buffer. */ SisRC fillFrom(uint8_t* buf, int* base, off_t len); |