changeset 271:eafaf362779e

fixup doxygen errors
author Carl Byington <carl@five-ten-sg.com>
date Thu, 21 Apr 2011 10:16:29 -0700
parents 6c73cd336d5d
children 345dab73b5c8
files src/libpst.c src/libpst.h
diffstat 2 files changed, 7 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/src/libpst.c	Sun Apr 17 19:27:26 2011 -0700
+++ b/src/libpst.c	Thu Apr 21 10:16:29 2011 -0700
@@ -4369,6 +4369,7 @@
 
 /** Get the default character set for this item. This is used to find
  *  the charset for pst_string elements that are not already in utf8 encoding.
+ *
  *  @param  item   pointer to the mapi item of interest
  *  @param[in]  buflen  length of the output buffer
  *  @param[out] result  pointer to output buffer, must be at least 30 bytes
@@ -4384,7 +4385,6 @@
 
 /** Convert str to rfc2231 encoding of str
  *
- *  @param item  pointer to the containing mapi item
  *  @param str   pointer to the mapi string of interest
  */
 void pst_rfc2231(pst_string *str) {
@@ -4421,8 +4421,9 @@
 
 /** Convert str to rfc2047 encoding of str, possibly enclosed in quotes if it contains spaces
  *
- *  @param item  pointer to the containing mapi item
- *  @param str   pointer to the mapi string of interest
+ *  @param item          pointer to the containing mapi item
+ *  @param str           pointer to the mapi string of interest
+ *  @param needs_quote   true if strings containing spaces should be wrapped in quotes
  */
 void pst_rfc2047(pst_item *item, pst_string *str, int needs_quote) {
     int has_space = 0;
--- a/src/libpst.h	Sun Apr 17 19:27:26 2011 -0700
+++ b/src/libpst.h	Thu Apr 21 10:16:29 2011 -0700
@@ -1071,15 +1071,15 @@
 
 
 /** Convert str to rfc2231 encoding of str
- *  @param item  pointer to the containing mapi item
  *  @param str   pointer to the mapi string of interest
  */
 void            pst_rfc2231(pst_string *str);
 
 
 /** Convert str to rfc2047 encoding of str, possibly enclosed in quotes if it contains spaces
- *  @param item  pointer to the containing mapi item
- *  @param str   pointer to the mapi string of interest
+ *  @param item          pointer to the containing mapi item
+ *  @param str           pointer to the mapi string of interest
+ *  @param needs_quote   true if strings containing spaces should be wrapped in quotes
  */
 void            pst_rfc2047(pst_item *item, pst_string *str, int needs_quote);