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/sisfilerecord.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'lib/sisfilerecord.h') diff --git a/lib/sisfilerecord.h b/lib/sisfilerecord.h index 0f6526b..dbbbc49 100644 --- a/lib/sisfilerecord.h +++ b/lib/sisfilerecord.h @@ -39,6 +39,12 @@ 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* sisFile); -- cgit v1.2.3