aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFritz Elfert <felfert@to.com>2001-02-04 05:01:10 +0000
committerFritz Elfert <felfert@to.com>2001-02-04 05:01:10 +0000
commitd80b8811641f8305ba6a1215b5393c6de3e6792e (patch)
tree8ddd0b0d42081b2383a102a2d26185a2d055089b
parentc7cbabf6e0d49af464d248d0737745d723ea07cb (diff)
downloadplptools-d80b8811641f8305ba6a1215b5393c6de3e6792e.tar.gz
plptools-d80b8811641f8305ba6a1215b5393c6de3e6792e.tar.bz2
plptools-d80b8811641f8305ba6a1215b5393c6de3e6792e.zip
More doc changes.
-rw-r--r--lib/bufferstore.h5
-rw-r--r--lib/psitime.h2
-rw-r--r--lib/rfsv16.h2
-rw-r--r--lib/rfsv32.h2
4 files changed, 7 insertions, 4 deletions
diff --git a/lib/bufferstore.h b/lib/bufferstore.h
index d9c2e54..a018e81 100644
--- a/lib/bufferstore.h
+++ b/lib/bufferstore.h
@@ -187,7 +187,10 @@ public:
* Appends data to the content of this instance.
*
* @param b The bufferStore whose content to append.
- * @param maxLen Length of content.
+ * @param maxLen Length of content to append. If
+ * @p maxLen is less than 0 or greater than
+ * the current length of @p b , then the
+ * whole content of @p b is appended.
*/
void addBuff(const bufferStore &b, long maxLen = -1);
diff --git a/lib/psitime.h b/lib/psitime.h
index 0650cda..2b26379 100644
--- a/lib/psitime.h
+++ b/lib/psitime.h
@@ -83,7 +83,7 @@ typedef struct psi_timezone_t {
* NOTE: For proper conversion, the current timezone of
* the Psion has to be set. For EPOC devices, the
* timezone can be evaluated using
- * @ref rpcs::getMachineInfo. For SIBO devices,
+ * @ref rpcs::getMachineInfo . For SIBO devices,
* unfortunately there is no known method of retrieving
* this information. Therefore, if the timezone is
* <em>not</em> set, a fallback using the environment
diff --git a/lib/rfsv16.h b/lib/rfsv16.h
index 33aba60..a94aa5f 100644
--- a/lib/rfsv16.h
+++ b/lib/rfsv16.h
@@ -4,7 +4,7 @@
#include "rfsv.h"
/**
- * This is the implementation of the @rfsv protocol for
+ * This is the implementation of the @ref rfsv protocol for
* Psion series 3 (SIBO) variant.
* For a complete documentation, see @ref rfsv .
*/
diff --git a/lib/rfsv32.h b/lib/rfsv32.h
index 4df18b3..abbc6ad 100644
--- a/lib/rfsv32.h
+++ b/lib/rfsv32.h
@@ -5,7 +5,7 @@
#include "plpdirent.h"
/**
- * This is the implementation of the @rfsv protocol for
+ * This is the implementation of the @ref rfsv protocol for
* Psion series 5 (EPOC) variant.
* For a complete documentation, see @ref rfsv .
*/