aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sisfile.h
diff options
context:
space:
mode:
authorDaniel Brahneborg <basic@chello.se>2002-03-06 20:03:48 +0000
committerDaniel Brahneborg <basic@chello.se>2002-03-06 20:03:48 +0000
commitc989ceb038fcfe5d583928dfd1f8b0cf6a301cbe (patch)
treea938f3d1e5123e1505a4fd3840c3182f8d6395ee /lib/sisfile.h
parentaa59faec168326365c6bdc6743dffec336862a6a (diff)
downloadplptools-c989ceb038fcfe5d583928dfd1f8b0cf6a301cbe.tar.gz
plptools-c989ceb038fcfe5d583928dfd1f8b0cf6a301cbe.tar.bz2
plptools-c989ceb038fcfe5d583928dfd1f8b0cf6a301cbe.zip
Document most of the method arguments with @param.
Diffstat (limited to 'lib/sisfile.h')
-rw-r--r--lib/sisfile.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/sisfile.h b/lib/sisfile.h
index 02e400b..cae00ee 100644
--- a/lib/sisfile.h
+++ b/lib/sisfile.h
@@ -40,6 +40,9 @@ class SISFile
public:
/**
* Populate the fields.
+ *
+ * @param buf The buffer to read from.
+ * @param len The length of the buffer.
*/
SisRC fillFrom(uint8_t* buf, off_t len);