aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sislangrecord.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/sislangrecord.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/sislangrecord.h')
-rw-r--r--lib/sislangrecord.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/sislangrecord.h b/lib/sislangrecord.h
index 5aecd4a..4b6e7ae 100644
--- a/lib/sislangrecord.h
+++ b/lib/sislangrecord.h
@@ -35,10 +35,21 @@ 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.
*/
SisRC fillFrom(uint8_t* buf, int* base, off_t len);
+ /**
+ * The language number.
+ *
+ * @see langTable
+ */
uint16_t m_lang;
+
};
#endif