aboutsummaryrefslogtreecommitdiffstats
path: root/epan
diff options
context:
space:
mode:
authorUlf Lamping <ulf.lamping@web.de>2005-09-21 20:11:55 +0000
committerUlf Lamping <ulf.lamping@web.de>2005-09-21 20:11:55 +0000
commita8ef1df32bcfdb0d16e9c90b2f8d9b88daecdeb5 (patch)
tree80696b0c0505725d96100c7b5c391c64e2db4280 /epan
parent512a4983c0baf086ae7909b71e61ed970d98c946 (diff)
fix/add doxygen comments
svn path=/trunk/; revision=15941
Diffstat (limited to 'epan')
-rw-r--r--epan/tvbuff.h4
-rw-r--r--epan/xmlstub.h24
2 files changed, 14 insertions, 14 deletions
diff --git a/epan/tvbuff.h b/epan/tvbuff.h
index 01648b0979..efe9ef6d4a 100644
--- a/epan/tvbuff.h
+++ b/epan/tvbuff.h
@@ -393,7 +393,7 @@ extern gint tvb_pbrk_guint8(tvbuff_t *, gint offset, gint maxlength,
*/
extern guint tvb_strsize(tvbuff_t *tvb, gint offset);
-/** Find length of string by looking for end of string ('\0'), up to
+/** Find length of string by looking for end of zero terminated string, up to
* 'maxlength' characters'; if 'maxlength' is -1, searches to end
* of tvbuff.
* Returns -1 if 'maxlength' reached before finding EOS. */
@@ -430,7 +430,7 @@ extern gchar *tvb_format_stringzpad(tvbuff_t *tvb, gint offset, gint size);
/**
* Given a tvbuff, an offset, and a length, allocate a buffer big enough
* to hold a non-null-terminated string of that length at that offset,
- * plus a trailing '\0', copy the string into it, and return a pointer
+ * plus a trailing zero, copy the string into it, and return a pointer
* to the string.
*
* Throws an exception if the tvbuff ends before the string does.
diff --git a/epan/xmlstub.h b/epan/xmlstub.h
index 2bf30e551d..ea9ac44968 100644
--- a/epan/xmlstub.h
+++ b/epan/xmlstub.h
@@ -546,19 +546,19 @@ typedef enum {
/**
* xmlCharEncodingInputFunc:
- * @out: a pointer ot an array of bytes to store the UTF-8 result
- * @outlen: the length of @out
- * @in: a pointer ot an array of chars in the original encoding
- * @inlen: the length of @in
+ * @param out a pointer ot an array of bytes to store the UTF-8 result
+ * @param outlen the length of out
+ * @param in a pointer ot an array of chars in the original encoding
+ * @param inlen the length of in
*
* Take a block of chars in the original encoding and try to convert
* it to an UTF-8 block of chars out.
*
* Returns the number of byte written, or -1 by lack of space, or -2
* if the transcoding failed.
- * The value of @inlen after return is the number of octets consumed
+ * The value of inlen after return is the number of octets consumed
* as the return value is positive, else unpredictiable.
- * The value of @outlen after return is the number of ocetes consumed.
+ * The value of outlen after return is the number of ocetes consumed.
*/
typedef int (* xmlCharEncodingInputFunc)(unsigned char* out, int *outlen,
const unsigned char* in, int *inlen);
@@ -566,10 +566,10 @@ typedef int (* xmlCharEncodingInputFunc)(unsigned char* out, int *outlen,
/**
* xmlCharEncodingOutputFunc:
- * @out: a pointer ot an array of bytes to store the result
- * @outlen: the length of @out
- * @in: a pointer ot an array of UTF-8 chars
- * @inlen: the length of @in
+ * @param out a pointer ot an array of bytes to store the result
+ * @param outlen the length of out
+ * @param in a pointer ot an array of UTF-8 chars
+ * @param inlen the length of in
*
* Take a block of UTF-8 chars in and try to convert it to an other
* encoding.
@@ -578,9 +578,9 @@ typedef int (* xmlCharEncodingInputFunc)(unsigned char* out, int *outlen,
*
* Returns the number of byte written, or -1 by lack of space, or -2
* if the transcoding failed.
- * The value of @inlen after return is the number of octets consumed
+ * The value of inlen after return is the number of octets consumed
* as the return value is positive, else unpredictiable.
- * The value of @outlen after return is the number of ocetes consumed.
+ * The value of outlen after return is the number of ocetes consumed.
*/
typedef int (* xmlCharEncodingOutputFunc)(unsigned char* out, int *outlen,
const unsigned char* in, int *inlen);