From c989ceb038fcfe5d583928dfd1f8b0cf6a301cbe Mon Sep 17 00:00:00 2001 From: Daniel Brahneborg Date: Wed, 6 Mar 2002 20:03:48 +0000 Subject: Document most of the method arguments with @param. --- lib/sisreqrecord.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'lib/sisreqrecord.h') 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; -- cgit v1.2.3