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/sisreqrecord.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/sisreqrecord.h')
-rw-r--r-- | lib/sisreqrecord.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/lib/sisreqrecord.h b/lib/sisreqrecord.h index 7219fe4..12bf535 100644 --- a/lib/sisreqrecord.h +++ b/lib/sisreqrecord.h @@ -37,8 +37,14 @@ public: /** * Populate the fields. + * + * @param buf The buffer to read from. + * @param base The index to start reading from, which is updated + * when the record is successfully read. + * @param len The length of the buffer. + * @param sisFile The container SISFile. */ - SisRC fillFrom(uint8_t* buf, int* base, off_t len, SISFile* file); + SisRC fillFrom(uint8_t* buf, int* base, off_t len, SISFile* sisFile); uint32_t m_uid; uint16_t m_major; |