gmime r1315 - trunk/gmime
- From: fejj svn gnome org
- To: svn-commits-list gnome org
- Subject: gmime r1315 - trunk/gmime
- Date: Sat, 31 May 2008 19:35:14 +0000 (UTC)
Author: fejj
Date: Sat May 31 19:35:13 2008
New Revision: 1315
URL: http://svn.gnome.org/viewvc/gmime?rev=1315&view=rev
Log:
fixed some gtk-doc comments
Modified:
trunk/gmime/gmime-charset.c
trunk/gmime/gmime-cipher-context.c
trunk/gmime/gmime-content-type.c
trunk/gmime/gmime-data-wrapper.c
trunk/gmime/gmime-disposition.c
trunk/gmime/gmime-encodings.c
trunk/gmime/gmime-encodings.h
trunk/gmime/gmime-filter-basic.c
trunk/gmime/gmime-filter-best.c
trunk/gmime/gmime-filter-charset.c
trunk/gmime/gmime-filter-crlf.c
trunk/gmime/gmime-filter-enriched.c
trunk/gmime/gmime-filter-from.c
trunk/gmime/gmime-filter-gzip.c
trunk/gmime/gmime-filter-html.c
trunk/gmime/gmime-filter-md5.c
trunk/gmime/gmime-filter-strip.c
trunk/gmime/gmime-filter-windows.c
trunk/gmime/gmime-filter-yenc.c
trunk/gmime/gmime-filter.c
trunk/gmime/gmime-gpg-context.c
trunk/gmime/gmime-header.c
trunk/gmime/gmime-header.h
trunk/gmime/gmime-iconv-utils.c
trunk/gmime/gmime-iconv.c
trunk/gmime/gmime-iconv.h
trunk/gmime/gmime-message-part.c
trunk/gmime/gmime-message-partial.c
trunk/gmime/gmime-message.c
trunk/gmime/gmime-multipart-encrypted.c
trunk/gmime/gmime-multipart-signed.c
trunk/gmime/gmime-multipart.c
trunk/gmime/gmime-object.c
trunk/gmime/gmime-param.c
trunk/gmime/gmime-parse-utils.c
trunk/gmime/gmime-parser.c
trunk/gmime/gmime-part.c
trunk/gmime/gmime-session.c
trunk/gmime/gmime-stream-buffer.c
trunk/gmime/gmime-stream-cat.c
trunk/gmime/gmime-stream-file.c
trunk/gmime/gmime-stream-filter.c
trunk/gmime/gmime-stream-fs.c
trunk/gmime/gmime-stream-mem.c
trunk/gmime/gmime-stream-mmap.c
trunk/gmime/gmime-stream-null.c
trunk/gmime/gmime-stream.c
trunk/gmime/gmime-utils.c
trunk/gmime/gmime.c
trunk/gmime/internet-address.c
Modified: trunk/gmime/gmime-charset.c
==============================================================================
--- trunk/gmime/gmime-charset.c (original)
+++ trunk/gmime/gmime-charset.c Sat May 31 19:35:13 2008
@@ -324,7 +324,7 @@
*
* Gets the user's locale charset (or iso-8859-1 by default).
*
- * Returns the user's locale charset (or iso-8859-1 by default).
+ * Returns: the user's locale charset (or iso-8859-1 by default).
**/
const char *
g_mime_locale_charset (void)
@@ -343,7 +343,7 @@
*
* Gets the user's locale language code (or %NULL by default).
*
- * Returns the user's locale language code (or %NULL by default).
+ * Returns: the user's locale language code (or %NULL by default).
**/
const char *
g_mime_locale_language (void)
@@ -365,7 +365,7 @@
* @charset. Currently only handles CJK and Russian/Ukranian
* charset->lang mapping. Everything else will return %NULL.
*
- * Returns a language code that is specific to @charset, or %NULL on
+ * Returns: a language code that is specific to @charset, or %NULL on
* fail.
**/
const char *
@@ -405,7 +405,7 @@
*
* Attempts to find an iconv-friendly charset name for @charset.
*
- * Returns an iconv-friendly charset name for @charset.
+ * Returns: an iconv-friendly charset name for @charset.
**/
const char *
g_mime_charset_iconv_name (const char *charset)
@@ -538,7 +538,7 @@
* the canonical ISO charset names (such as using ISO8859-1 rather
* than the canonical form ISO-8859-1).
*
- * Returns a canonical charset name for @charset.
+ * Returns: a canonical charset name for @charset.
**/
const char *
g_mime_charset_canon_name (const char *charset)
@@ -590,7 +590,7 @@
* Note: This function is deprecated. Use g_mime_charset_iconv_name()
* instead.
*
- * Returns an iconv-friendly charset name for @charset.
+ * Returns: an iconv-friendly charset name for @charset.
**/
const char *
g_mime_charset_name (const char *charset)
@@ -607,7 +607,7 @@
* Note: This function is deprecated. Use g_mime_locale_charset()
* instead.
*
- * Returns the user's locale charset (or iso-8859-1 by default).
+ * Returns: the user's locale charset (or iso-8859-1 by default).
**/
const char *
g_mime_charset_locale_name (void)
@@ -623,7 +623,7 @@
* Maps the ISO-8859-# charset to the equivalent Windows-CP125#
* charset.
*
- * Returns equivalent Windows charset.
+ * Returns: equivalent Windows charset.
**/
const char *
g_mime_charset_iso_to_windows (const char *isocharset)
@@ -767,7 +767,7 @@
*
* Gets the best charset name based on the charset mask @charset.
*
- * Returns a pointer to a string containing the best charset name that
+ * Returns: a pointer to a string containing the best charset name that
* can represent the charset mask @charset.
**/
const char *
@@ -789,7 +789,7 @@
*
* Computes the best charset to use to encode this text buffer.
*
- * Returns the charset name best suited for the input text or %NULL if
+ * Returns: the charset name best suited for the input text or %NULL if
* it is US-ASCII safe.
**/
const char *
@@ -813,7 +813,7 @@
*
* Check to see if the UTF-8 @text will fit safely within @charset.
*
- * Returns %TRUE if it is safe to encode @text into @charset or %FALSE
+ * Returns: %TRUE if it is safe to encode @text into @charset or %FALSE
* otherwise.
**/
gboolean
@@ -923,7 +923,7 @@
* Get the list of user-preferred charsets set with
* g_mime_set_user_charsets().
*
- * Returns an array of user-set charsets or %NULL if none set.
+ * Returns: an array of user-set charsets or %NULL if none set.
**/
const char **
g_mime_user_charsets (void)
Modified: trunk/gmime/gmime-cipher-context.c
==============================================================================
--- trunk/gmime/gmime-cipher-context.c (original)
+++ trunk/gmime/gmime-cipher-context.c Sat May 31 19:35:13 2008
@@ -148,7 +148,7 @@
*
* Gets the hash id based on the hash name @hash.
*
- * Returns the equivalent hash id or #GMIME_CIPHER_HASH_DEFAULT on fail.
+ * Returns: the equivalent hash id or #GMIME_CIPHER_HASH_DEFAULT on fail.
**/
GMimeCipherHash
g_mime_cipher_context_hash_id (GMimeCipherContext *ctx, const char *hash)
@@ -174,7 +174,7 @@
*
* Gets the hash name based on the hash id @hash.
*
- * Returns the equivalent hash name or %NULL on fail.
+ * Returns: the equivalent hash name or %NULL on fail.
**/
const char *
g_mime_cipher_context_hash_name (GMimeCipherContext *ctx, GMimeCipherHash hash)
@@ -207,7 +207,7 @@
*
* Signs the input stream and writes the resulting signature to the output stream.
*
- * Returns %0 on success or %-1 on fail.
+ * Returns: %0 on success or %-1 on fail.
**/
int
g_mime_cipher_context_sign (GMimeCipherContext *ctx, const char *userid, GMimeCipherHash hash,
@@ -245,7 +245,7 @@
* @sigstream is assumed to be the signature stream and is used to
* verify the integirity of the @istream.
*
- * Returns a #GMimeSignatureValidity structure containing information
+ * Returns: a #GMimeSignatureValidity structure containing information
* about the integrity of the input stream or %NULL on failure to
* execute at all.
**/
@@ -284,7 +284,7 @@
* Encrypts (and optionally signs) the cleartext input stream and
* writes the resulting ciphertext to the output stream.
*
- * Returns %0 on success or %-1 on fail.
+ * Returns: %0 on success or %-1 on fail.
**/
int
g_mime_cipher_context_encrypt (GMimeCipherContext *ctx, gboolean sign, const char *userid, GPtrArray *recipients,
@@ -319,7 +319,7 @@
* Decrypts the ciphertext input stream and writes the resulting
* cleartext to the output stream.
*
- * Returns %0 on success or %-1 for fail.
+ * Returns: %0 on success or %-1 for fail.
**/
int
g_mime_cipher_context_decrypt (GMimeCipherContext *ctx, GMimeStream *istream,
@@ -352,7 +352,7 @@
* Imports a stream of keys/certificates contained within @istream
* into the key/certificate database controlled by @ctx.
*
- * Returns %0 on success or %-1 on fail.
+ * Returns: %0 on success or %-1 on fail.
**/
int
g_mime_cipher_context_import_keys (GMimeCipherContext *ctx, GMimeStream *istream, GError **err)
@@ -385,7 +385,7 @@
* Exports the keys/certificates in @keys to the stream @ostream from
* the key/certificate database controlled by @ctx.
*
- * Returns %0 on success or %-1 on fail.
+ * Returns: %0 on success or %-1 on fail.
**/
int
g_mime_cipher_context_export_keys (GMimeCipherContext *ctx, GPtrArray *keys,
@@ -404,7 +404,7 @@
*
* Allocates an new GMimeSigner.
*
- * Returns a new #GMimeSigner.
+ * Returns: a new #GMimeSigner.
**/
GMimeSigner *
g_mime_signer_new (void)
@@ -447,7 +447,7 @@
*
* Creates a new #GMimeSignatureValidity.
*
- * Returns a new #GMimeSignatureValidity.
+ * Returns: a new #GMimeSignatureValidity.
**/
GMimeSignatureValidity *
g_mime_signature_validity_new (void)
@@ -499,7 +499,7 @@
*
* Gets the signature status (GOOD, BAD, UNKNOWN).
*
- * Returns a #GMimeSignatureStatus value.
+ * Returns: a #GMimeSignatureStatus value.
**/
GMimeSignatureStatus
g_mime_signature_validity_get_status (GMimeSignatureValidity *validity)
@@ -533,7 +533,7 @@
*
* Gets any user-readable status details.
*
- * Returns a user-readable string containing any status information.
+ * Returns: a user-readable string containing any status information.
**/
const char *
g_mime_signature_validity_get_details (GMimeSignatureValidity *validity)
@@ -567,7 +567,7 @@
*
* Gets the list of signers.
*
- * Returns a #GMimeSigner list which contain further information such
+ * Returns: a #GMimeSigner list which contain further information such
* as trust and cipher keys.
**/
const GMimeSigner *
Modified: trunk/gmime/gmime-content-type.c
==============================================================================
--- trunk/gmime/gmime-content-type.c (original)
+++ trunk/gmime/gmime-content-type.c Sat May 31 19:35:13 2008
@@ -64,7 +64,7 @@
*
* Creates a Content-Type object with type @type and subtype @subtype.
*
- * Returns a new MIME Content-Type object.
+ * Returns: a new MIME Content-Type object.
**/
GMimeContentType *
g_mime_content_type_new (const char *type, const char *subtype)
@@ -108,7 +108,7 @@
*
* Constructs a new Content-Type object based on the input string.
*
- * Returns a new MIME Content-Type based on the input string.
+ * Returns: a new MIME Content-Type based on the input string.
**/
GMimeContentType *
g_mime_content_type_new_from_string (const char *str)
@@ -204,7 +204,7 @@
* Allocates a string buffer containing the type and subtype defined
* by the @mime_type.
*
- * Returns an allocated string containing the type and subtype of the
+ * Returns: an allocated string containing the type and subtype of the
* content-type in the format: type/subtype.
**/
char *
@@ -231,7 +231,7 @@
* Compares the given type and subtype with that of the given mime
* type object.
*
- * Returns TRUE if the MIME types match or FALSE otherwise. You may
+ * Returns: TRUE if the MIME types match or FALSE otherwise. You may
* use "*" in place of @type and/or @subtype as a wilcard.
**/
gboolean
@@ -263,7 +263,7 @@
*
* Gets the Content-Type's media type.
*
- * Returns the Content-Type's media type.
+ * Returns: the Content-Type's media type.
**/
const char *
g_mime_content_type_get_media_type (const GMimeContentType *mime_type)
@@ -280,7 +280,7 @@
*
* Gets the Content-Type's media sub-type.
*
- * Returns the Content-Type's media sub-type.
+ * Returns: the Content-Type's media sub-type.
**/
const char *
g_mime_content_type_get_media_subtype (const GMimeContentType *mime_type)
@@ -297,7 +297,7 @@
*
* Gets the Content-Type's parameter list.
*
- * Returns the Content-Type's parameter list.
+ * Returns: the Content-Type's parameter list.
**/
const GMimeParam *
g_mime_content_type_get_params (const GMimeContentType *mime_type)
@@ -354,7 +354,7 @@
*
* Gets the parameter value specified by @attribute if it's available.
*
- * Returns a const pointer to the paramer value specified by
+ * Returns: a const pointer to the paramer value specified by
* @attribute or %NULL on fail.
**/
const char *
Modified: trunk/gmime/gmime-data-wrapper.c
==============================================================================
--- trunk/gmime/gmime-data-wrapper.c (original)
+++ trunk/gmime/gmime-data-wrapper.c Sat May 31 19:35:13 2008
@@ -112,7 +112,7 @@
*
* Creates a new GMimeDataWrapper object.
*
- * Returns a new data wrapper object.
+ * Returns: a new data wrapper object.
**/
GMimeDataWrapper *
g_mime_data_wrapper_new (void)
@@ -128,7 +128,7 @@
*
* Creates a new #GMimeDataWrapper object around @stream.
*
- * Returns a data wrapper around @stream. Since the wrapper owns its
+ * Returns: a data wrapper around @stream. Since the wrapper owns its
* own reference on the stream, caller is responsible for unrefing
* its own copy.
**/
@@ -184,7 +184,7 @@
*
* Gets a reference to the stream wrapped by @wrapper.
*
- * Returns a reference to the internal stream. Caller is responsible
+ * Returns: a reference to the internal stream. Caller is responsible
* for unrefing it.
**/
GMimeStream *
@@ -223,7 +223,7 @@
*
* Gets the encoding type of the stream wrapped by @wrapper.
*
- * Returns the encoding type of the internal stream.
+ * Returns: the encoding type of the internal stream.
**/
GMimeContentEncoding
g_mime_data_wrapper_get_encoding (GMimeDataWrapper *wrapper)
@@ -274,7 +274,7 @@
*
* Writes the raw (decoded) data to the output stream.
*
- * Returns the number of bytes written or %-1 on failure.
+ * Returns: the number of bytes written or %-1 on failure.
**/
ssize_t
g_mime_data_wrapper_write_to_stream (GMimeDataWrapper *wrapper, GMimeStream *stream)
Modified: trunk/gmime/gmime-disposition.c
==============================================================================
--- trunk/gmime/gmime-disposition.c (original)
+++ trunk/gmime/gmime-disposition.c Sat May 31 19:35:13 2008
@@ -50,7 +50,7 @@
*
* Creates a new #GMimeContentDisposition object.
*
- * Returns a new #GMimeContentDisposition object.
+ * Returns: a new #GMimeContentDisposition object.
**/
GMimeContentDisposition *
g_mime_content_disposition_new (void)
@@ -73,7 +73,7 @@
*
* Creates a new #GMimeContentDisposition object.
*
- * Returns a new #GMimeContentDisposition object.
+ * Returns: a new #GMimeContentDisposition object.
**/
GMimeContentDisposition *
g_mime_content_disposition_new_from_string (const char *str)
@@ -165,7 +165,7 @@
*
* Gets the disposition or %NULL on fail.
*
- * Returns the disposition string which is probably one of
+ * Returns: the disposition string which is probably one of
* #GMIME_DISPOSITION_ATTACHMENT or #GMIME_DISPOSITION_INLINE.
**/
const char *
@@ -238,7 +238,7 @@
*
* Gets the value of the parameter @attribute, or %NULL on fail.
*
- * Returns the value of the parameter of name @attribute.
+ * Returns: the value of the parameter of name @attribute.
**/
const char *
g_mime_content_disposition_get_parameter (const GMimeContentDisposition *disposition, const char *attribute)
@@ -266,7 +266,7 @@
* Allocates a string buffer containing the Content-Disposition header
* represented by the disposition object @disposition.
*
- * Returns a string containing the disposition header
+ * Returns: a string containing the disposition header
**/
char *
g_mime_content_disposition_to_string (const GMimeContentDisposition *disposition, gboolean fold)
Modified: trunk/gmime/gmime-encodings.c
==============================================================================
--- trunk/gmime/gmime-encodings.c (original)
+++ trunk/gmime/gmime-encodings.c Sat May 31 19:35:13 2008
@@ -107,7 +107,7 @@
* Gets the appropriate #GMimeContentEncoding enumeration value based
* on the input string.
*
- * Returns the #GMimeContentEncoding specified by @str or
+ * Returns: the #GMimeContentEncoding specified by @str or
* #GMIME_CONTENT_ENCODING_DEFAULT on error.
**/
GMimeContentEncoding
@@ -138,7 +138,7 @@
*
* Gets the string value of the content encoding.
*
- * Returns the encoding type as a string or %NULL on error. Available
+ * Returns: the encoding type as a string or %NULL on error. Available
* values for the encoding are: #GMIME_CONTENT_ENCODING_DEFAULT,
* #GMIME_CONTENT_ENCODING_7BIT, #GMIME_CONTENT_ENCODING_8BIT,
* #GMIME_CONTENT_ENCODING_BINARY, #GMIME_CONTENT_ENCODING_BASE64,
@@ -234,7 +234,7 @@
* Given the input length, @inlen, calculate the needed output length
* to perform an encoding or decoding step.
*
- * Returns the maximum number of bytes needed to encode or decode a
+ * Returns: the maximum number of bytes needed to encode or decode a
* buffer of @inlen bytes.
**/
size_t
@@ -276,7 +276,7 @@
* g_mime_encoding_outlen() to find out how large @outbuf might need
* to be.
*
- * Returns the number of bytes written to @outbuf.
+ * Returns: the number of bytes written to @outbuf.
**/
size_t
g_mime_encoding_step (GMimeEncoding *state, const char *inbuf, size_t inlen, char *outbuf)
@@ -317,7 +317,7 @@
* Completes the incremental encode or decode of the input stream (see
* g_mime_encoding_step() for details).
*
- * Returns the number of bytes written to @outbuf.
+ * Returns: the number of bytes written to @outbuf.
**/
size_t
g_mime_encoding_flush (GMimeEncoding *state, const char *inbuf, size_t inlen, char *outbuf)
@@ -360,7 +360,7 @@
* when finished encoding data with g_mime_encoding_base64_encode_step()
* to flush off the last little bit.
*
- * Returns the number of bytes encoded.
+ * Returns: the number of bytes encoded.
**/
size_t
g_mime_encoding_base64_encode_close (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf, int *state, guint32 *save)
@@ -410,7 +410,7 @@
* left-over state in state and save (initialise to 0 on first
* invocation).
*
- * Returns the number of bytes encoded.
+ * Returns: the number of bytes encoded.
**/
size_t
g_mime_encoding_base64_encode_step (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf, int *state, guint32 *save)
@@ -495,7 +495,7 @@
*
* Decodes a chunk of base64 encoded data.
*
- * Returns the number of bytes decoded (which have been dumped in
+ * Returns: the number of bytes decoded (which have been dumped in
* @outbuf).
**/
size_t
@@ -561,7 +561,7 @@
* Uuencodes a chunk of data. Call this when finished encoding data
* with g_mime_encoding_uuencode_step() to flush off the last little bit.
*
- * Returns the number of bytes encoded.
+ * Returns: the number of bytes encoded.
**/
size_t
g_mime_encoding_uuencode_close (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf, unsigned char *uubuf, int *state, guint32 *save)
@@ -643,7 +643,7 @@
* state in @uubuf, @state and @save (initialize to 0 on first
* invocation).
*
- * Returns the number of bytes encoded.
+ * Returns: the number of bytes encoded.
**/
size_t
g_mime_encoding_uuencode_step (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf, unsigned char *uubuf, int *state, guint32 *save)
@@ -758,7 +758,7 @@
* uuencoded data. Assumes the "begin mode filename" line has
* been stripped off.
*
- * Returns the number of bytes decoded.
+ * Returns: the number of bytes decoded.
**/
size_t
g_mime_encoding_uudecode_step (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf, int *state, guint32 *save)
@@ -861,7 +861,7 @@
* encoding data with g_mime_encoding_quoted_encode_step() to flush off
* the last little bit.
*
- * Returns the number of bytes encoded.
+ * Returns: the number of bytes encoded.
**/
size_t
g_mime_encoding_quoted_encode_close (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf, int *state, guint32 *save)
@@ -906,7 +906,7 @@
* step', saves left-over state in state and save (initialise to -1 on
* first invocation).
*
- * Returns the number of bytes encoded.
+ * Returns: the number of bytes encoded.
**/
size_t
g_mime_encoding_quoted_encode_step (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf, int *state, guint32 *save)
@@ -999,7 +999,7 @@
* Decodes a block of quoted-printable encoded data. Performs a
* 'decode step' on a chunk of QP encoded data.
*
- * Returns the number of bytes decoded.
+ * Returns: the number of bytes decoded.
**/
size_t
g_mime_encoding_quoted_decode_step (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf, int *state, guint32 *save)
Modified: trunk/gmime/gmime-encodings.h
==============================================================================
--- trunk/gmime/gmime-encodings.h (original)
+++ trunk/gmime/gmime-encodings.h Sat May 31 19:35:13 2008
@@ -62,7 +62,7 @@
* Calculates the maximum number of bytes needed to base64 encode the
* full input buffer of length @x.
*
- * Returns the number of output bytes needed to base64 encode an input
+ * Returns: the number of output bytes needed to base64 encode an input
* buffer of size @x.
**/
#define GMIME_BASE64_ENCODE_LEN(x) ((size_t) (((((x) + 2) / 57) * 77) + 77))
@@ -75,7 +75,7 @@
* Calculates the maximum number of bytes needed to encode the full
* input buffer of length @x using the quoted-printable encoding.
*
- * Returns the number of output bytes needed to encode an input buffer
+ * Returns: the number of output bytes needed to encode an input buffer
* of size @x using the quoted-printable encoding.
**/
#define GMIME_QP_ENCODE_LEN(x) ((size_t) (((x) + 1) * 3))
@@ -88,7 +88,7 @@
* Calculates the maximum number of bytes needed to uuencode the full
* input buffer of length @x.
*
- * Returns the number of output bytes needed to uuencode an input
+ * Returns: the number of output bytes needed to uuencode an input
* buffer of size @x.
**/
#define GMIME_UUENCODE_LEN(x) ((size_t) (((((x) + 2) / 45) * 62) + 62))
Modified: trunk/gmime/gmime-filter-basic.c
==============================================================================
--- trunk/gmime/gmime-filter-basic.c (original)
+++ trunk/gmime/gmime-filter-basic.c Sat May 31 19:35:13 2008
@@ -238,7 +238,7 @@
*
* Creates a new basic filter for @encoding.
*
- * Returns a new basic encoder filter.
+ * Returns: a new basic encoder filter.
**/
GMimeFilter *
g_mime_filter_basic_new (GMimeContentEncoding encoding, gboolean encode)
Modified: trunk/gmime/gmime-filter-best.c
==============================================================================
--- trunk/gmime/gmime-filter-best.c (original)
+++ trunk/gmime/gmime-filter-best.c Sat May 31 19:35:13 2008
@@ -237,7 +237,7 @@
* Note: In order for the g_mime_filter_best_charset() function to
* work, the stream being filtered MUST already be encoded in UTF-8.
*
- * Returns a new best filter with flags @flags.
+ * Returns: a new best filter with flags @flags.
**/
GMimeFilter *
g_mime_filter_best_new (unsigned int flags)
@@ -259,7 +259,7 @@
* Calculates the best charset for encoding the stream filtered
* through the @best filter.
*
- * Returns a pointer to a string containing the name of the charset
+ * Returns: a pointer to a string containing the name of the charset
* best suited for the text filtered through @best.
**/
const char *
@@ -286,7 +286,7 @@
* Calculates the best Content-Transfer-Encoding for the stream
* filtered through @best that fits within the @required encoding.
*
- * Returns the best encoding for the stream filtered by @best.
+ * Returns: the best encoding for the stream filtered by @best.
**/
GMimeContentEncoding
g_mime_filter_best_encoding (GMimeFilterBest *best, GMimeBestEncoding required)
Modified: trunk/gmime/gmime-filter-charset.c
==============================================================================
--- trunk/gmime/gmime-filter-charset.c (original)
+++ trunk/gmime/gmime-filter-charset.c Sat May 31 19:35:13 2008
@@ -284,7 +284,7 @@
*
* Creates a new #GMimeFilterCharset filter.
*
- * Returns a new charset filter.
+ * Returns: a new charset filter.
**/
GMimeFilter *
g_mime_filter_charset_new (const char *from_charset, const char *to_charset)
Modified: trunk/gmime/gmime-filter-crlf.c
==============================================================================
--- trunk/gmime/gmime-filter-crlf.c (original)
+++ trunk/gmime/gmime-filter-crlf.c Sat May 31 19:35:13 2008
@@ -220,7 +220,7 @@
*
* Creates a new GMimeFilterCRLF filter.
*
- * Returns a new crlf(/dot) filter.
+ * Returns: a new crlf(/dot) filter.
**/
GMimeFilter *
g_mime_filter_crlf_new (GMimeFilterCRLFDirection direction, GMimeFilterCRLFMode mode)
Modified: trunk/gmime/gmime-filter-enriched.c
==============================================================================
--- trunk/gmime/gmime-filter-enriched.c (original)
+++ trunk/gmime/gmime-filter-enriched.c Sat May 31 19:35:13 2008
@@ -597,7 +597,7 @@
*
* Creates a new GMimeFilterEnriched object.
*
- * Returns a new GMimeFilter object.
+ * Returns: a new GMimeFilter object.
**/
GMimeFilter *
g_mime_filter_enriched_new (guint32 flags)
Modified: trunk/gmime/gmime-filter-from.c
==============================================================================
--- trunk/gmime/gmime-filter-from.c (original)
+++ trunk/gmime/gmime-filter-from.c Sat May 31 19:35:13 2008
@@ -245,7 +245,7 @@
* remember to also use a #GMimeFilterBasic filter with mode
* #GMIME_FILTER_BASIC_QP_ENC.
*
- * Returns a new from filter with mode @mode.
+ * Returns: a new from filter with mode @mode.
**/
GMimeFilter *
g_mime_filter_from_new (GMimeFilterFromMode mode)
Modified: trunk/gmime/gmime-filter-gzip.c
==============================================================================
--- trunk/gmime/gmime-filter-gzip.c (original)
+++ trunk/gmime/gmime-filter-gzip.c Sat May 31 19:35:13 2008
@@ -471,7 +471,7 @@
*
* Creates a new gzip (or gunzip) filter.
*
- * Returns a new gzip (or gunzip) filter.
+ * Returns: a new gzip (or gunzip) filter.
**/
GMimeFilter *
g_mime_filter_gzip_new (GMimeFilterGZipMode mode, int level)
Modified: trunk/gmime/gmime-filter-html.c
==============================================================================
--- trunk/gmime/gmime-filter-html.c (original)
+++ trunk/gmime/gmime-filter-html.c Sat May 31 19:35:13 2008
@@ -474,7 +474,7 @@
* Creates a new GMimeFilterHTML filter which can be used to convert a
* plain UTF-8 text stream into an html stream.
*
- * Returns a new html filter.
+ * Returns: a new html filter.
**/
GMimeFilter *
g_mime_filter_html_new (guint32 flags, guint32 colour)
Modified: trunk/gmime/gmime-filter-md5.c
==============================================================================
--- trunk/gmime/gmime-filter-md5.c (original)
+++ trunk/gmime/gmime-filter-md5.c Sat May 31 19:35:13 2008
@@ -157,7 +157,7 @@
*
* Creates a new Md5 filter.
*
- * Returns a new Md5 filter.
+ * Returns: a new Md5 filter.
**/
GMimeFilter *
g_mime_filter_md5_new (void)
Modified: trunk/gmime/gmime-filter-strip.c
==============================================================================
--- trunk/gmime/gmime-filter-strip.c (original)
+++ trunk/gmime/gmime-filter-strip.c Sat May 31 19:35:13 2008
@@ -175,7 +175,7 @@
* Creates a new #GMimeFilterStrip filter which will strip trailing
* whitespace from every line of input passed through the filter.
*
- * Returns a new strip filter.
+ * Returns: a new strip filter.
**/
GMimeFilter *
g_mime_filter_strip_new (void)
Modified: trunk/gmime/gmime-filter-windows.c
==============================================================================
--- trunk/gmime/gmime-filter-windows.c (original)
+++ trunk/gmime/gmime-filter-windows.c Sat May 31 19:35:13 2008
@@ -176,7 +176,7 @@
* been filtered, it can be determined whether or not said text stream
* was in @claimed_charset or the equivalent Windows-CP125# charset.
*
- * Returns a new windows filter.
+ * Returns: a new windows filter.
**/
GMimeFilter *
g_mime_filter_windows_new (const char *claimed_charset)
@@ -199,7 +199,7 @@
* Determines whether or not a Windows-CP125# charset has been
* detected so far.
*
- * Returns %TRUE if the filtered stream has been detected to contain
+ * Returns: %TRUE if the filtered stream has been detected to contain
* Windows-CP125# characters or %FALSE otherwise.
**/
gboolean
@@ -217,7 +217,7 @@
*
* Figures out the real charset that the text is encoded in based on whether or not Windows-CP125# characters were found.
*
- * Returns a const string pointer to the claimed charset if filtered
+ * Returns: a const string pointer to the claimed charset if filtered
* text stream was found not to contain any Windows-CP125# characters
* or the proper Windows-CP125# charset.
**/
Modified: trunk/gmime/gmime-filter-yenc.c
==============================================================================
--- trunk/gmime/gmime-filter-yenc.c (original)
+++ trunk/gmime/gmime-filter-yenc.c Sat May 31 19:35:13 2008
@@ -284,7 +284,7 @@
*
* Creates a new yEnc filter.
*
- * Returns a new yEnc filter.
+ * Returns: a new yEnc filter.
**/
GMimeFilter *
g_mime_filter_yenc_new (GMimeFilterYencDirection direction)
@@ -349,7 +349,7 @@
*
* Gets the part id of the current decoded yEnc stream or %-1 on fail.
*
- * Returns the part id of the current decoded yEnc stream or %-1 on
+ * Returns: the part id of the current decoded yEnc stream or %-1 on
* fail.
**/
int
@@ -370,7 +370,7 @@
*
* Get the computed part crc or (guint32) -1 on fail.
*
- * Returns the computed part crc or (guint32) -1 on fail.
+ * Returns: the computed part crc or (guint32) -1 on fail.
**/
guint32
g_mime_filter_yenc_get_pcrc (GMimeFilterYenc *yenc)
@@ -387,7 +387,7 @@
*
* Get the computed crc or (guint32) -1 on fail.
*
- * Returns the computed crc or (guint32) -1 on fail.
+ * Returns: the computed crc or (guint32) -1 on fail.
**/
guint32
g_mime_filter_yenc_get_crc (GMimeFilterYenc *yenc)
@@ -457,7 +457,7 @@
* combined crc32 value of all the parts using #GMIME_YENCODE_CRC_FINAL
* (@crc).
*
- * Returns the number of bytes decoded.
+ * Returns: the number of bytes decoded.
**/
size_t
g_mime_ydecode_step (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf,
@@ -537,7 +537,7 @@
* Along the same lines, @pcrc and @crc should be initialized to
* #GMIME_YENCODE_CRC_INIT before using.
*
- * Returns the number of bytes encoded.
+ * Returns: the number of bytes encoded.
**/
size_t
g_mime_yencode_step (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf,
@@ -602,7 +602,7 @@
* #GMIME_YENCODE_CRC_FINAL (@crc) to get the combined crc32 value of
* all the parts.
*
- * Returns the number of bytes encoded.
+ * Returns: the number of bytes encoded.
**/
size_t
g_mime_yencode_close (const unsigned char *inbuf, size_t inlen, unsigned char *outbuf,
Modified: trunk/gmime/gmime-filter.c
==============================================================================
--- trunk/gmime/gmime-filter.c (original)
+++ trunk/gmime/gmime-filter.c Sat May 31 19:35:13 2008
@@ -144,7 +144,7 @@
*
* Copies @filter into a new GMimeFilter object.
*
- * Returns a duplicate of @filter.
+ * Returns: a duplicate of @filter.
**/
GMimeFilter *
g_mime_filter_copy (GMimeFilter *filter)
Modified: trunk/gmime/gmime-gpg-context.c
==============================================================================
--- trunk/gmime/gmime-gpg-context.c (original)
+++ trunk/gmime/gmime-gpg-context.c Sat May 31 19:35:13 2008
@@ -1839,7 +1839,7 @@
*
* Creates a new gpg cipher context object.
*
- * Returns a new gpg cipher context object.
+ * Returns: a new gpg cipher context object.
**/
GMimeCipherContext *
g_mime_gpg_context_new (GMimeSession *session, const char *path)
@@ -1867,7 +1867,7 @@
*
* Gets the @always_trust flag on the gpg context.
*
- * Returns the @always_trust flag on the gpg context.
+ * Returns: the @always_trust flag on the gpg context.
**/
gboolean
g_mime_gpg_context_get_always_trust (GMimeGpgContext *ctx)
Modified: trunk/gmime/gmime-header.c
==============================================================================
--- trunk/gmime/gmime-header.c (original)
+++ trunk/gmime/gmime-header.c Sat May 31 19:35:13 2008
@@ -88,7 +88,7 @@
*
* Creates a new #GMimeHeader.
*
- * Returns a new #GMimeHeader with the specified values.
+ * Returns: a new #GMimeHeader with the specified values.
**/
static GMimeHeader *
g_mime_header_new (const char *name, const char *value, gint64 offset)
@@ -127,7 +127,7 @@
*
* Copies a header iterator.
*
- * Returns a new #GMimeHeaderIter which matches @iter's state.
+ * Returns: a new #GMimeHeaderIter which matches @iter's state.
**/
GMimeHeaderIter *
g_mime_header_iter_copy (GMimeHeaderIter *iter)
@@ -172,7 +172,7 @@
*
* Check that @iter1 and @iter2 reference the same header.
*
- * Returns %TRUE if @iter1 and @iter2 refer to the same header or
+ * Returns: %TRUE if @iter1 and @iter2 refer to the same header or
* %FALSE otherwise.
**/
gboolean
@@ -193,7 +193,7 @@
* invalid if the #GMimeHeaderList that the iterator refers to changes
* or is destroyed.
*
- * Returns %TRUE if @iter is still valid or %FALSE otherwise.
+ * Returns: %TRUE if @iter is still valid or %FALSE otherwise.
**/
gboolean
g_mime_header_iter_is_valid (GMimeHeaderIter *iter)
@@ -210,7 +210,7 @@
*
* Updates @iter to point to the first header.
*
- * Returns %TRUE on success or %FALSE otherwise.
+ * Returns: %TRUE on success or %FALSE otherwise.
**/
gboolean
g_mime_header_iter_first (GMimeHeaderIter *iter)
@@ -239,7 +239,7 @@
*
* Updates @iter to point to the last header.
*
- * Returns %TRUE on success or %FALSE otherwise.
+ * Returns: %TRUE on success or %FALSE otherwise.
**/
gboolean
g_mime_header_iter_last (GMimeHeaderIter *iter)
@@ -268,7 +268,7 @@
*
* Advances to the next header.
*
- * Returns %TRUE on success or %FALSE otherwise.
+ * Returns: %TRUE on success or %FALSE otherwise.
**/
gboolean
g_mime_header_iter_next (GMimeHeaderIter *iter)
@@ -298,7 +298,7 @@
*
* Advances to the previous header.
*
- * Returns %TRUE on success or %FALSE otherwise.
+ * Returns: %TRUE on success or %FALSE otherwise.
**/
gboolean
g_mime_header_iter_prev (GMimeHeaderIter *iter)
@@ -328,7 +328,7 @@
*
* Gets the current header's file/stream offset.
*
- * Returns the file/stream offset or %-1 if unknown or invalid.
+ * Returns: the file/stream offset or %-1 if unknown or invalid.
**/
gint64
g_mime_header_iter_get_offset (GMimeHeaderIter *iter)
@@ -348,7 +348,7 @@
*
* Gets the current header's name.
*
- * Returns the header name or %NULL if invalid.
+ * Returns: the header name or %NULL if invalid.
**/
const char *
g_mime_header_iter_get_name (GMimeHeaderIter *iter)
@@ -368,7 +368,7 @@
*
* Sets the current header's value.
*
- * Returns %TRUE if the value was set or %FALSE otherwise (indicates
+ * Returns: %TRUE if the value was set or %FALSE otherwise (indicates
* invalid iter).
**/
gboolean
@@ -394,7 +394,7 @@
*
* Gets the current header's name.
*
- * Returns the header name or %NULL if invalid.
+ * Returns: the header name or %NULL if invalid.
**/
const char *
g_mime_header_iter_get_value (GMimeHeaderIter *iter)
@@ -414,7 +414,7 @@
*
* Removes the current header and advances to the next header.
*
- * Returns %TRUE on success or %FALSE otherwise
+ * Returns: %TRUE on success or %FALSE otherwise
**/
gboolean
g_mime_header_iter_remove (GMimeHeaderIter *iter)
@@ -504,7 +504,7 @@
*
* Creates a new #GMimeHeaderList object.
*
- * Returns a new header list object.
+ * Returns: a new header list object.
**/
GMimeHeaderList *
g_mime_header_list_new (void)
@@ -620,7 +620,7 @@
*
* Gets the value of the first header with the name requested.
*
- * Returns the value of the header requested.
+ * Returns: the value of the header requested.
**/
const char *
g_mime_header_list_get (const GMimeHeaderList *headers, const char *name)
@@ -678,7 +678,7 @@
*
* Remove the specified header.
*
- * Returns %TRUE if the header was successfully removed or %FALSE if
+ * Returns: %TRUE if the header was successfully removed or %FALSE if
* the specified header could not be found.
**/
gboolean
@@ -722,7 +722,7 @@
*
* Gets a new iterator for traversing @headers.
*
- * Returns a new #GMimeHeaderIter which must be freed using
+ * Returns: a new #GMimeHeaderIter which must be freed using
* g_mime_header_iter_free() when finished with it.
**/
GMimeHeaderIter *
@@ -763,7 +763,7 @@
*
* Write the headers to a stream.
*
- * Returns the number of bytes written or %-1 on fail.
+ * Returns: the number of bytes written or %-1 on fail.
**/
ssize_t
g_mime_header_list_write_to_stream (const GMimeHeaderList *headers, GMimeStream *stream)
@@ -807,7 +807,7 @@
* Allocates a string buffer containing the raw rfc822 headers
* contained in @headers.
*
- * Returns a string containing the header block.
+ * Returns: a string containing the header block.
**/
char *
g_mime_header_list_to_string (const GMimeHeaderList *headers)
@@ -888,7 +888,7 @@
*
* Gets whether or not a raw header has been set on @headers.
*
- * Returns %TRUE if a raw header is set or %FALSE otherwise.
+ * Returns: %TRUE if a raw header is set or %FALSE otherwise.
**/
gboolean
g_mime_header_list_has_raw (const GMimeHeaderList *headers)
Modified: trunk/gmime/gmime-header.h
==============================================================================
--- trunk/gmime/gmime-header.h (original)
+++ trunk/gmime/gmime-header.h Sat May 31 19:35:13 2008
@@ -71,7 +71,7 @@
* Function signature for the callback to
* g_mime_header_register_writer().
*
- * Returns the number of bytes written or %-1 on error.
+ * Returns: the number of bytes written or %-1 on error.
**/
typedef ssize_t (* GMimeHeaderWriter) (GMimeStream *stream, const char *name, const char *value);
Modified: trunk/gmime/gmime-iconv-utils.c
==============================================================================
--- trunk/gmime/gmime-iconv-utils.c (original)
+++ trunk/gmime/gmime-iconv-utils.c Sat May 31 19:35:13 2008
@@ -95,7 +95,7 @@
* converted to the destination charset as described by the conversion
* descriptor @cd.
*
- * Returns a new string buffer containing the first @n bytes of
+ * Returns: a new string buffer containing the first @n bytes of
* @str converted to the destination charset as described by the
* conversion descriptor @cd.
**/
@@ -190,7 +190,7 @@
* Allocates a new string buffer containing @str converted to the
* destination charset described in @cd.
*
- * Returns a new string buffer containing the original string
+ * Returns: a new string buffer containing the original string
* converted to the new charset.
**/
char *
@@ -206,7 +206,7 @@
*
* Allocates a new string buffer containing @str in UTF-8.
*
- * Returns a new string buffer containing @str converted to UTF-8.
+ * Returns: a new string buffer containing @str converted to UTF-8.
**/
char *
g_mime_iconv_locale_to_utf8 (const char *str)
@@ -231,7 +231,7 @@
* Allocates a new string buffer containing the first @n bytes of
* @str converted to UTF-8.
*
- * Returns a new string buffer containing the first @n bytes of
+ * Returns: a new string buffer containing the first @n bytes of
* @str converted to UTF-8.
**/
char *
@@ -256,7 +256,7 @@
* Allocates a new string buffer containing @str converted to the
* user's locale charset.
*
- * Returns a new string buffer containing @str converted to the
+ * Returns: a new string buffer containing @str converted to the
* user's locale charset.
**/
char *
@@ -282,7 +282,7 @@
* Allocates a new string buffer containing the first @n bytes of
* @str converted to the user's locale charset.
*
- * Returns a new string buffer containing the first @n bytes of
+ * Returns: a new string buffer containing the first @n bytes of
* @str converted to the user's locale charset.
**/
char *
Modified: trunk/gmime/gmime-iconv.c
==============================================================================
--- trunk/gmime/gmime-iconv.c (original)
+++ trunk/gmime/gmime-iconv.c Sat May 31 19:35:13 2008
@@ -100,7 +100,7 @@
* Creates a new cache node, inserts it into the cache and increments
* the cache size.
*
- * Returns a pointer to the newly allocated cache node.
+ * Returns: a pointer to the newly allocated cache node.
**/
static IconvCacheNode *
iconv_cache_node_new (const char *key, iconv_t cd)
@@ -232,7 +232,7 @@
*
* See the manual page for iconv_open(3) for further details.
*
- * Returns a new conversion descriptor for use with g_mime_iconv() on
+ * Returns: a new conversion descriptor for use with g_mime_iconv() on
* success or (iconv_t) %-1 on fail as well as setting an appropriate
* errno value.
**/
@@ -315,7 +315,7 @@
*
* See the manual page for iconv_close(3) for further details.
*
- * Returns %0 on success or %-1 on fail as well as setting an
+ * Returns: %0 on success or %-1 on fail as well as setting an
* appropriate errno value.
**/
int
Modified: trunk/gmime/gmime-iconv.h
==============================================================================
--- trunk/gmime/gmime-iconv.h (original)
+++ trunk/gmime/gmime-iconv.h Sat May 31 19:35:13 2008
@@ -92,7 +92,7 @@
* #g_mime_iconv function sets @cd's conversion state to the initial
* state.
*
- * Returns the number of characters converted in a nonreversible way
+ * Returns: the number of characters converted in a nonreversible way
* during this call; reversible conversions are not counted. In case
* of error, it sets errno and returns (size_t)(-1).
**/
Modified: trunk/gmime/gmime-message-part.c
==============================================================================
--- trunk/gmime/gmime-message-part.c (original)
+++ trunk/gmime/gmime-message-part.c Sat May 31 19:35:13 2008
@@ -235,7 +235,7 @@
* Creates a new MIME message part object with a default content-type
* of message/@subtype.
*
- * Returns an empty MIME message part object with a default
+ * Returns: an empty MIME message part object with a default
* content-type of message/@subtype.
**/
GMimeMessagePart *
@@ -261,7 +261,7 @@
* Creates a new MIME message part object with a default content-type
* of message/@subtype containing @message.
*
- * Returns a MIME message part object with a default content-type of
+ * Returns: a MIME message part object with a default content-type of
* message/@subtype containing @message.
**/
GMimeMessagePart *
@@ -305,7 +305,7 @@
*
* Gets the message object on the message part object @part.
*
- * Returns the message part contained within @part.
+ * Returns: the message part contained within @part.
**/
GMimeMessage *
g_mime_message_part_get_message (GMimeMessagePart *part)
Modified: trunk/gmime/gmime-message-partial.c
==============================================================================
--- trunk/gmime/gmime-message-partial.c (original)
+++ trunk/gmime/gmime-message-partial.c Sat May 31 19:35:13 2008
@@ -207,7 +207,7 @@
*
* Creates a new MIME message/partial object.
*
- * Returns an empty MIME message/partial object.
+ * Returns: an empty MIME message/partial object.
**/
GMimeMessagePartial *
g_mime_message_partial_new (const char *id, int number, int total)
@@ -245,7 +245,7 @@
*
* Gets the message/partial id parameter value.
*
- * Returns the message/partial id or %NULL on fail.
+ * Returns: the message/partial id or %NULL on fail.
**/
const char *
g_mime_message_partial_get_id (GMimeMessagePartial *partial)
@@ -262,7 +262,7 @@
*
* Gets the message/partial part number.
*
- * Returns the message/partial part number or %-1 on fail.
+ * Returns: the message/partial part number or %-1 on fail.
**/
int
g_mime_message_partial_get_number (GMimeMessagePartial *partial)
@@ -280,7 +280,7 @@
* Gets the total number of message/partial parts needed to
* reconstruct the original message.
*
- * Returns the total number of message/partial parts needed to
+ * Returns: the total number of message/partial parts needed to
* reconstruct the original message or -1 on fail.
**/
int
@@ -314,7 +314,7 @@
* Reconstructs the GMimeMessage from the given message/partial parts
* in @partials.
*
- * Returns a GMimeMessage object on success or %NULL on fail.
+ * Returns: a GMimeMessage object on success or %NULL on fail.
**/
GMimeMessage *
g_mime_message_partial_reconstruct_message (GMimeMessagePartial **partials, size_t num)
@@ -421,7 +421,7 @@
* @max_size bytes or fewer. @nparts is set to the number of
* #GMimeMessagePartial objects created.
*
- * Returns an array of #GMimeMessage objects and sets @nparts to th
+ * Returns: an array of #GMimeMessage objects and sets @nparts to th
* number of messages returned or %NULL on fail.
**/
GMimeMessage **
Modified: trunk/gmime/gmime-message.c
==============================================================================
--- trunk/gmime/gmime-message.c (original)
+++ trunk/gmime/gmime-message.c Sat May 31 19:35:13 2008
@@ -914,7 +914,7 @@
* strictly a cosmetic thing, so if you are unsure, it is safe to say
* no (%FALSE).
*
- * Returns an empty MIME Message object.
+ * Returns: an empty MIME Message object.
**/
GMimeMessage *
g_mime_message_new (gboolean pretty_headers)
@@ -971,7 +971,7 @@
*
* Gets the email address of the sender from @message.
*
- * Returns the sender's name and address of the MIME Message.
+ * Returns: the sender's name and address of the MIME Message.
**/
const char *
g_mime_message_get_sender (GMimeMessage *message)
@@ -1008,7 +1008,7 @@
*
* Gets the Reply-To address from @message.
*
- * Returns the sender's Reply-To address from the MIME Message.
+ * Returns: the sender's Reply-To address from the MIME Message.
**/
const char *
g_mime_message_get_reply_to (GMimeMessage *message)
@@ -1121,7 +1121,7 @@
* recipient types include: #GMIME_RECIPIENT_TYPE_TO,
* #GMIME_RECIPIENT_TYPE_CC and #GMIME_RECIPIENT_TYPE_BCC.
*
- * Returns a list of recipients of a chosen type from the MIME
+ * Returns: a list of recipients of a chosen type from the MIME
* Message.
**/
const InternetAddressList *
@@ -1146,7 +1146,7 @@
*
* Gets the complete list of recipients for @message.
*
- * Returns a newly allocated #InternetAddressList containing all
+ * Returns: a newly allocated #InternetAddressList containing all
* recipients of the message.
**/
InternetAddressList *
@@ -1208,7 +1208,7 @@
*
* Gets the message's subject.
*
- * Returns the unencoded UTF-8 Subject field on a MIME Message.
+ * Returns: the unencoded UTF-8 Subject field on a MIME Message.
**/
const char *
g_mime_message_get_subject (GMimeMessage *message)
@@ -1271,7 +1271,7 @@
*
* Gets the message's sent date in string format.
*
- * Returns the sent-date of the MIME Message in string format.
+ * Returns: the sent-date of the MIME Message in string format.
**/
char *
g_mime_message_get_date_string (GMimeMessage *message)
@@ -1317,7 +1317,7 @@
*
* Gets the Message-Id header of @message.
*
- * Returns the Message-Id of a message.
+ * Returns: the Message-Id of a message.
**/
const char *
g_mime_message_get_message_id (GMimeMessage *message)
@@ -1334,7 +1334,7 @@
*
* Gets the toplevel MIME part contained within @message.
*
- * Returns the toplevel MIME part of @message.
+ * Returns: the toplevel MIME part of @message.
**/
GMimeObject *
g_mime_message_get_mime_part (GMimeMessage *message)
Modified: trunk/gmime/gmime-multipart-encrypted.c
==============================================================================
--- trunk/gmime/gmime-multipart-encrypted.c (original)
+++ trunk/gmime/gmime-multipart-encrypted.c Sat May 31 19:35:13 2008
@@ -206,7 +206,7 @@
*
* Creates a new MIME multipart/encrypted object.
*
- * Returns an empty MIME multipart/encrypted object.
+ * Returns: an empty MIME multipart/encrypted object.
**/
GMimeMultipartEncrypted *
g_mime_multipart_encrypted_new (void)
@@ -236,7 +236,7 @@
* encrypted #GMimeObject is set as the encrypted part of the
* multipart/encrypted object @mpe.
*
- * Returns %0 on success or %-1 on fail. If the encryption fails, an
+ * Returns: %0 on success or %-1 on fail. If the encryption fails, an
* exception will be set on @err to provide information as to why the
* failure occured.
**/
@@ -330,7 +330,7 @@
* Attempts to decrypt the encrypted MIME part contained within the
* multipart/encrypted object @mpe using the @ctx decryption context.
*
- * Returns the decrypted MIME part on success or %NULL on fail. If the
+ * Returns: the decrypted MIME part on success or %NULL on fail. If the
* decryption fails, an exception will be set on @err to provide
* information as to why the failure occured.
**/
Modified: trunk/gmime/gmime-multipart-signed.c
==============================================================================
--- trunk/gmime/gmime-multipart-signed.c (original)
+++ trunk/gmime/gmime-multipart-signed.c Sat May 31 19:35:13 2008
@@ -209,7 +209,7 @@
*
* Creates a new MIME multipart/signed object.
*
- * Returns an empty MIME multipart/signed object.
+ * Returns: an empty MIME multipart/signed object.
**/
GMimeMultipartSigned *
g_mime_multipart_signed_new (void)
@@ -281,7 +281,7 @@
* successful, the signed #GMimeObject is set as the signed part of
* the multipart/signed object @mps.
*
- * Returns %0 on success or %-1 on fail. If the signing fails, an
+ * Returns: %0 on success or %-1 on fail. If the signing fails, an
* exception will be set on @err to provide information as to why the
* failure occured.
**/
@@ -401,8 +401,8 @@
* Attempts to verify the signed MIME part contained within the
* multipart/signed object @mps using the @ctx cipher context.
*
- * Returns a new #GMimeCipherValidity object on success or %NULL on
- * fail. If the signing fails, an exception will be set on @err to
+ * Returns: a new #GMimeSignatureValidity object on success or %NULL
+ * on fail. If the signing fails, an exception will be set on @err to
* provide information as to why the failure occured.
**/
GMimeSignatureValidity *
Modified: trunk/gmime/gmime-multipart.c
==============================================================================
--- trunk/gmime/gmime-multipart.c (original)
+++ trunk/gmime/gmime-multipart.c Sat May 31 19:35:13 2008
@@ -324,7 +324,7 @@
* Creates a new MIME multipart object with a default content-type of
* multipart/mixed.
*
- * Returns an empty MIME multipart object with a default content-type of
+ * Returns: an empty MIME multipart object with a default content-type of
* multipart/mixed.
**/
GMimeMultipart *
@@ -349,7 +349,7 @@
* Creates a new MIME multipart object with a content-type of
* multipart/@subtype.
*
- * Returns an empty MIME multipart object with a content-type of
+ * Returns: an empty MIME multipart object with a content-type of
* multipart/@subtype.
**/
GMimeMultipart *
@@ -390,7 +390,7 @@
*
* Gets the preface on the multipart.
*
- * Returns a pointer to the preface string on the multipart.
+ * Returns: a pointer to the preface string on the multipart.
**/
const char *
g_mime_multipart_get_preface (GMimeMultipart *multipart)
@@ -424,7 +424,7 @@
*
* Gets the postface on the multipart.
*
- * Returns a pointer to the postface string on the multipart.
+ * Returns: a pointer to the postface string on the multipart.
**/
const char *
g_mime_multipart_get_postface (GMimeMultipart *multipart)
@@ -576,7 +576,7 @@
*
* Removes the mime part at position @index from the multipart.
*
- * Returns the mime part that was removed.
+ * Returns: the mime part that was removed.
**/
GMimeObject *
g_mime_multipart_remove_part_at (GMimeMultipart *multipart, int index)
@@ -614,7 +614,7 @@
*
* Gets the mime part at position @index within the multipart.
*
- * Returns the mime part at position @index.
+ * Returns: the mime part at position @index.
**/
GMimeObject *
g_mime_multipart_get_part (GMimeMultipart *multipart, int index)
@@ -642,7 +642,7 @@
*
* Gets the number of mime parts contained within the multipart.
*
- * Returns the number of mime parts contained within the multipart.
+ * Returns: the number of mime parts contained within the multipart.
**/
int
g_mime_multipart_get_number (GMimeMultipart *multipart)
@@ -742,7 +742,7 @@
* %NULL, then an auto-generated boundary will be set on the multipart
* and returned.
*
- * Returns the boundary on the multipart.
+ * Returns: the boundary on the multipart.
**/
const char *
g_mime_multipart_get_boundary (GMimeMultipart *multipart)
@@ -788,7 +788,7 @@
* Gets the mime part with the content-id @content_id from the
* multipart @multipart.
*
- * Returns the GMimeObject whose content-id matches the search string,
+ * Returns: the GMimeObject whose content-id matches the search string,
* or %NULL if a match cannot be found.
**/
GMimeObject *
Modified: trunk/gmime/gmime-object.c
==============================================================================
--- trunk/gmime/gmime-object.c (original)
+++ trunk/gmime/gmime-object.c Sat May 31 19:35:13 2008
@@ -306,7 +306,7 @@
* class that can handle @type. If that also fails, then it will use
* the generic part class, #GMimePart.
*
- * Returns an appropriate #GMimeObject registered to handle mime-types
+ * Returns: an appropriate #GMimeObject registered to handle mime-types
* of @type/@subtype.
**/
GMimeObject *
@@ -383,10 +383,10 @@
* g_mime_object_get_content_type:
* @object: a #GMimeObject
*
- * Gets the Content-Type object for the given Mime object or %NULL on
- * fail.
+ * Gets the #GMimeContentType object for the given Mime object or
+ * %NULL on fail.
*
- * Returns the content-type object for the specified Mime object.
+ * Returns: the content-type object for the specified Mime object.
**/
const GMimeContentType *
g_mime_object_get_content_type (GMimeObject *object)
@@ -423,7 +423,7 @@
* Gets the value of the content-type param @name set on the Mime part
* @object.
*
- * Returns the value of the requested content-type param or %NULL on
+ * Returns: the value of the requested content-type param or %NULL on
* if the param doesn't exist.
**/
const char *
@@ -440,9 +440,9 @@
* g_mime_object_get_content_disposition:
* @object: a #GMimeObject
*
- * Get the content disposition for the specified Mime object.
+ * Gets the #GMimeContentDisposition for the specified Mime object.
*
- * Returns the #GMimeContentDisposition set on the Mime object.
+ * Returns: the #GMimeContentDisposition set on the Mime object.
**/
const GMimeContentDisposition *
g_mime_object_get_content_disposition (GMimeObject *object)
@@ -506,7 +506,7 @@
*
* Gets the Mime object's disposition if set or %NULL otherwise.
*
- * Returns the disposition string which is probably one of
+ * Returns: the disposition string which is probably one of
* #GMIME_DISPOSITION_ATTACHMENT or #GMIME_DISPOSITION_INLINE.
**/
const char *
@@ -552,7 +552,7 @@
* Gets the value of the Content-Disposition parameter specified by
* @attribute, or %NULL if the parameter does not exist.
*
- * Returns the value of a previously defined content-disposition
+ * Returns: the value of a previously defined content-disposition
* parameter specified by @attribute.
**/
const char *
@@ -597,7 +597,7 @@
*
* Gets the Content-Id of the Mime object or NULL if one is not set.
*
- * Returns a const pointer to the Content-Id header.
+ * Returns: a const pointer to the Content-Id header.
**/
const char *
g_mime_object_get_content_id (GMimeObject *object)
@@ -752,7 +752,7 @@
* Gets the value of the requested header if it exists or %NULL
* otherwise.
*
- * Returns the value of the header @header if it exists or %NULL
+ * Returns: the value of the header @header if it exists or %NULL
* otherwise.
**/
const char *
@@ -804,7 +804,7 @@
*
* Removed the specified header if it exists.
*
- * Returns %TRUE if the header was removed or %FALSE if it could not
+ * Returns: %TRUE if the header was removed or %FALSE if it could not
* be found.
**/
gboolean
@@ -831,7 +831,7 @@
* Allocates a string buffer containing all of the Mime object's raw
* headers.
*
- * Returns an allocated string containing all of the raw Mime headers.
+ * Returns: an allocated string containing all of the raw Mime headers.
**/
char *
g_mime_object_get_headers (GMimeObject *object)
@@ -856,7 +856,7 @@
*
* Write the contents of the Mime object to @stream.
*
- * Returns -1 on fail.
+ * Returns: the number of bytes written or %-1 on fail.
**/
ssize_t
g_mime_object_write_to_stream (GMimeObject *object, GMimeStream *stream)
@@ -874,7 +874,7 @@
*
* Allocates a string buffer containing the contents of @object.
*
- * Returns an allocated string containing the contents of the mime
+ * Returns: an allocated string containing the contents of the mime
* object.
**/
char *
@@ -907,7 +907,7 @@
*
* Get the header list for @object.
*
- * Returns the #GMimeHeaderList for @object. Do not free this pointer
+ * Returns: the #GMimeHeaderList for @object. Do not free this pointer
* when you are done with it.
**/
GMimeHeaderList *
Modified: trunk/gmime/gmime-param.c
==============================================================================
--- trunk/gmime/gmime-param.c (original)
+++ trunk/gmime/gmime-param.c Sat May 31 19:35:13 2008
@@ -71,7 +71,7 @@
*
* Creates a new #GMimeParam node with name @name and value @value.
*
- * Returns a new paramter structure.
+ * Returns: a new paramter structure.
**/
GMimeParam *
g_mime_param_new (const char *name, const char *value)
@@ -613,7 +613,7 @@
*
* Creates a parameter list based on the input string.
*
- * Returns a #GMimeParam structure based on @string.
+ * Returns: a #GMimeParam structure based on @string.
**/
GMimeParam *
g_mime_param_new_from_string (const char *str)
@@ -655,7 +655,7 @@
* Appends a new parameter with name @name and value @value to the
* parameter list @params.
*
- * Returns a param list with the new param of name @name and value
+ * Returns: a param list with the new param of name @name and value
* @value appended to the list of params @params.
**/
GMimeParam *
@@ -686,7 +686,7 @@
*
* Appends @param to the param list @params.
*
- * Returns a param list with the new param @param appended to the list
+ * Returns: a param list with the new param @param appended to the list
* of params @params.
**/
GMimeParam *
Modified: trunk/gmime/gmime-parse-utils.c
==============================================================================
--- trunk/gmime/gmime-parse-utils.c (original)
+++ trunk/gmime/gmime-parse-utils.c Sat May 31 19:35:13 2008
@@ -127,7 +127,7 @@
*
* Extracts the next rfc822 'word' token.
*
- * Returns the next rfc822 'word' token or %NULL if non exist.
+ * Returns: the next rfc822 'word' token or %NULL if non exist.
**/
char *
g_mime_decode_word (const char **in)
@@ -195,7 +195,7 @@
*
* Extracts the next rfc822 'domain' token.
*
- * Returns the next rfc822 'domain' token or %NULL if non exist.
+ * Returns: the next rfc822 'domain' token or %NULL if non exist.
**/
char *
g_mime_decode_domain (const char **in)
Modified: trunk/gmime/gmime-parser.c
==============================================================================
--- trunk/gmime/gmime-parser.c (original)
+++ trunk/gmime/gmime-parser.c Sat May 31 19:35:13 2008
@@ -361,7 +361,7 @@
*
* Creates a new parser object.
*
- * Returns a new parser object.
+ * Returns: a new parser object.
**/
GMimeParser *
g_mime_parser_new (void)
@@ -380,7 +380,7 @@
*
* Creates a new parser object preset to parse @stream.
*
- * Returns a new parser object.
+ * Returns: a new parser object.
**/
GMimeParser *
g_mime_parser_new_with_stream (GMimeStream *stream)
@@ -432,7 +432,7 @@
*
* Gets whether or not the underlying stream is persistent.
*
- * Returns %TRUE if the @parser will leave the content on disk or
+ * Returns: %TRUE if the @parser will leave the content on disk or
* %FALSE if it will load the content into memory.
**/
gboolean
@@ -477,7 +477,7 @@
*
* Gets whether or not @parser is set to scan mbox-style From-lines.
*
- * Returns whether or not @parser is set to scan mbox-style
+ * Returns: whether or not @parser is set to scan mbox-style
* From-lines.
**/
gboolean
@@ -512,7 +512,7 @@
* Gets whether or not @parser is set to use Content-Length for
* determining the offset of the end of the message.
*
- * Returns whether or not @parser is set to use Content-Length for
+ * Returns: whether or not @parser is set to use Content-Length for
* determining the offset of the end of the message.
**/
gboolean
@@ -646,7 +646,7 @@
*
* Gets the current stream offset from the parser's internal stream.
*
- * Returns the current stream offset from the parser's internal stream
+ * Returns: the current stream offset from the parser's internal stream
* or -1 on error.
**/
gint64
@@ -665,7 +665,7 @@
*
* Tests the end-of-stream indicator for @parser's internal stream.
*
- * Returns %TRUE on EOS or %FALSE otherwise.
+ * Returns: %TRUE on EOS or %FALSE otherwise.
**/
gboolean
g_mime_parser_eos (GMimeParser *parser)
@@ -1594,7 +1594,7 @@
*
* Constructs a MIME part from @parser.
*
- * Returns a MIME part based on @parser or %NULL on fail.
+ * Returns: a MIME part based on @parser or %NULL on fail.
**/
GMimeObject *
g_mime_parser_construct_part (GMimeParser *parser)
@@ -1673,7 +1673,7 @@
*
* Constructs a MIME message from @parser.
*
- * Returns a MIME message or %NULL on fail.
+ * Returns: a MIME message or %NULL on fail.
**/
GMimeMessage *
g_mime_parser_construct_message (GMimeParser *parser)
@@ -1691,7 +1691,7 @@
* Gets the mbox-style From-line of the most recently parsed message
* (gotten from g_mime_parser_construct_message()).
*
- * Returns the mbox-style From-line of the most recently parsed
+ * Returns: the mbox-style From-line of the most recently parsed
* message or %NULL on error.
**/
char *
@@ -1719,7 +1719,7 @@
* Gets the offset of the most recently parsed mbox-style From-line
* (gotten from g_mime_parser_construct_message()).
*
- * Returns the offset of the most recently parsed mbox-style From-line
+ * Returns: the offset of the most recently parsed mbox-style From-line
* or -1 on error.
**/
gint64
Modified: trunk/gmime/gmime-part.c
==============================================================================
--- trunk/gmime/gmime-part.c (original)
+++ trunk/gmime/gmime-part.c Sat May 31 19:35:13 2008
@@ -417,7 +417,7 @@
* Creates a new MIME Part object with a default content-type of
* text/plain.
*
- * Returns an empty MIME Part object with a default content-type of
+ * Returns: an empty MIME Part object with a default content-type of
* text/plain.
**/
GMimePart *
@@ -442,7 +442,7 @@
*
* Creates a new MIME Part with a sepcified type.
*
- * Returns an empty MIME Part object with the specified content-type.
+ * Returns: an empty MIME Part object with the specified content-type.
**/
GMimePart *
g_mime_part_new_with_type (const char *type, const char *subtype)
@@ -485,7 +485,7 @@
* Gets the value of the requested header if it exists, or %NULL
* otherwise.
*
- * Returns the value of the content header @header.
+ * Returns: the value of the content header @header.
**/
const char *
g_mime_part_get_content_header (GMimePart *mime_part, const char *header)
@@ -524,7 +524,7 @@
* Gets the value of the Content-Description for the specified mime
* part if it exists or %NULL otherwise.
*
- * Returns the content description for the specified mime part.
+ * Returns: the content description for the specified mime part.
**/
const char *
g_mime_part_get_content_description (const GMimePart *mime_part)
@@ -558,7 +558,7 @@
* Gets the content-id of the specified mime part if it exists, or
* %NULL otherwise.
*
- * Returns the content id for the specified mime part.
+ * Returns: the content id for the specified mime part.
**/
const char *
g_mime_part_get_content_id (GMimePart *mime_part)
@@ -639,7 +639,7 @@
*
* Verify the content md5 for the specified mime part.
*
- * Returns %TRUE if the md5 is valid or %FALSE otherwise. Note: will
+ * Returns: %TRUE if the md5 is valid or %FALSE otherwise. Note: will
* return %FALSE if the mime part does not contain a Content-MD5.
**/
gboolean
@@ -701,7 +701,7 @@
* Gets the md5sum contained in the Content-Md5 header of the
* specified mime part if it exists, or %NULL otherwise.
*
- * Returns the content md5 for the specified mime part.
+ * Returns: the content md5 for the specified mime part.
**/
const char *
g_mime_part_get_content_md5 (GMimePart *mime_part)
@@ -739,7 +739,7 @@
* Gets the value of the Content-Location header if it exists, or
* %NULL otherwise.
*
- * Returns the content location for the specified mime part.
+ * Returns: the content location for the specified mime part.
**/
const char *
g_mime_part_get_content_location (GMimePart *mime_part)
@@ -774,7 +774,7 @@
*
* Gets the content encoding of the mime part.
*
- * Returns the content encoding for the specified mime part.
+ * Returns: the content encoding for the specified mime part.
**/
GMimeContentEncoding
g_mime_part_get_content_encoding (GMimePart *mime_part)
@@ -815,7 +815,7 @@
* Gets the filename of the specificed mime part, or %NULL if the mime
* part does not have the filename or name parameter set.
*
- * Returns the filename of the specified MIME Part. It first checks to
+ * Returns: the filename of the specified MIME Part. It first checks to
* see if the "filename" parameter was set on the Content-Disposition
* and if not then checks the "name" parameter in the Content-Type.
**/
@@ -864,7 +864,7 @@
* Gets the internal data-wrapper of the specified mime part, or %NULL
* on error.
*
- * Returns the data-wrapper for the mime part's contents.
+ * Returns: the data-wrapper for the mime part's contents.
**/
GMimeDataWrapper *
g_mime_part_get_content_object (const GMimePart *mime_part)
Modified: trunk/gmime/gmime-session.c
==============================================================================
--- trunk/gmime/gmime-session.c (original)
+++ trunk/gmime/gmime-session.c Sat May 31 19:35:13 2008
@@ -118,7 +118,7 @@
* Gets whether or not the session is 'online' or not (online meaning
* that we are connected to the internet).
*
- * Returns %TRUE if the session is online or %FALSE otherwise.
+ * Returns: %TRUE if the session is online or %FALSE otherwise.
**/
gboolean
g_mime_session_is_online (GMimeSession *session)
@@ -150,7 +150,7 @@
*
* Requests the password for item @item.
*
- * Returns a string buffer containing the password for the requested
+ * Returns: a string buffer containing the password for the requested
* item or %NULL on fail.
**/
char *
Modified: trunk/gmime/gmime-stream-buffer.c
==============================================================================
--- trunk/gmime/gmime-stream-buffer.c (original)
+++ trunk/gmime/gmime-stream-buffer.c Sat May 31 19:35:13 2008
@@ -592,7 +592,7 @@
*
* Creates a new GMimeStreamBuffer object.
*
- * Returns a new buffer stream with source @source and mode @mode.
+ * Returns: a new buffer stream with source @source and mode @mode.
**/
GMimeStream *
g_mime_stream_buffer_new (GMimeStream *source, GMimeStreamBufferMode mode)
@@ -640,11 +640,11 @@
*
* Reads in at most one less than @max characters from @stream and
* stores them into the buffer pointed to by @buf. Reading stops after
- * an EOS or newline (#'\n'). If a newline is read, it is stored into
- * the buffer. A #'\0' is stored after the last character in the
+ * an EOS or newline ('\n'). If a newline is read, it is stored into
+ * the buffer. A '\0' is stored after the last character in the
* buffer.
*
- * Returns the number of characters read into @buf on success and -1
+ * Returns: the number of characters read into @buf on success or %-1
* on fail.
**/
ssize_t
Modified: trunk/gmime/gmime-stream-cat.c
==============================================================================
--- trunk/gmime/gmime-stream-cat.c (original)
+++ trunk/gmime/gmime-stream-cat.c Sat May 31 19:35:13 2008
@@ -675,7 +675,7 @@
*
* Creates a new GMimeStreamCat object.
*
- * Returns a new cat stream.
+ * Returns: a new cat stream.
**/
GMimeStream *
g_mime_stream_cat_new (void)
@@ -697,7 +697,7 @@
*
* Adds the @source stream to the cat stream @cat.
*
- * Returns %0 on success or %-1 on fail.
+ * Returns: %0 on success or %-1 on fail.
**/
int
g_mime_stream_cat_add_source (GMimeStreamCat *cat, GMimeStream *source)
Modified: trunk/gmime/gmime-stream-file.c
==============================================================================
--- trunk/gmime/gmime-stream-file.c (original)
+++ trunk/gmime/gmime-stream-file.c Sat May 31 19:35:13 2008
@@ -320,7 +320,7 @@
* Note: The created GMimeStreamFile object will own the FILE pointer
* passed in.
*
- * Returns a stream using @fp.
+ * Returns: a stream using @fp.
**/
GMimeStream *
g_mime_stream_file_new (FILE *fp)
@@ -352,7 +352,7 @@
* Note: The created GMimeStreamFile object will own the FILE pointer
* passed in.
*
- * Returns a stream using @fp with bounds @start and @end.
+ * Returns: a stream using @fp with bounds @start and @end.
**/
GMimeStream *
g_mime_stream_file_new_with_bounds (FILE *fp, gint64 start, gint64 end)
@@ -374,7 +374,7 @@
*
* Gets whether or not @stream owns the backend FILE pointer.
*
- * Returns %TRUE if @stream owns the backend FILE pointer or %FALSE
+ * Returns: %TRUE if @stream owns the backend FILE pointer or %FALSE
* otherwise.
**/
gboolean
Modified: trunk/gmime/gmime-stream-filter.c
==============================================================================
--- trunk/gmime/gmime-stream-filter.c (original)
+++ trunk/gmime/gmime-stream-filter.c Sat May 31 19:35:13 2008
@@ -405,7 +405,7 @@
* Creates a new GMimeStreamFilter object using @stream as the source
* stream.
*
- * Returns a new filter stream with @stream as its source.
+ * Returns: a new filter stream with @stream as its source.
**/
GMimeStream *
g_mime_stream_filter_new_with_stream (GMimeStream *stream)
@@ -433,7 +433,7 @@
*
* Adds a @filter to @fstream.
*
- * Returns an id for the filter.
+ * Returns: an id for the filter.
**/
int
g_mime_stream_filter_add (GMimeStreamFilter *fstream, GMimeFilter *filter)
Modified: trunk/gmime/gmime-stream-fs.c
==============================================================================
--- trunk/gmime/gmime-stream-fs.c (original)
+++ trunk/gmime/gmime-stream-fs.c Sat May 31 19:35:13 2008
@@ -363,7 +363,7 @@
*
* Creates a new GMimeStreamFs object around @fd.
*
- * Returns a stream using @fd.
+ * Returns: a stream using @fd.
**/
GMimeStream *
g_mime_stream_fs_new (int fd)
@@ -393,7 +393,7 @@
* Creates a new GMimeStreamFs object around @fd with bounds @start
* and @end.
*
- * Returns a stream using @fd with bounds @start and @end.
+ * Returns: a stream using @fd with bounds @start and @end.
**/
GMimeStream *
g_mime_stream_fs_new_with_bounds (int fd, gint64 start, gint64 end)
@@ -416,7 +416,7 @@
*
* Gets whether or not @stream owns the backend file descriptor.
*
- * Returns %TRUE if @stream owns the backend file descriptor or %FALSE
+ * Returns: %TRUE if @stream owns the backend file descriptor or %FALSE
* otherwise.
**/
gboolean
Modified: trunk/gmime/gmime-stream-mem.c
==============================================================================
--- trunk/gmime/gmime-stream-mem.c (original)
+++ trunk/gmime/gmime-stream-mem.c Sat May 31 19:35:13 2008
@@ -291,7 +291,7 @@
*
* Creates a new GMimeStreamMem object.
*
- * Returns a new memory stream.
+ * Returns: a new memory stream.
**/
GMimeStream *
g_mime_stream_mem_new (void)
@@ -314,7 +314,7 @@
*
* Creates a new GMimeStreamMem with data @array.
*
- * Returns a new memory stream using @array.
+ * Returns: a new memory stream using @array.
**/
GMimeStream *
g_mime_stream_mem_new_with_byte_array (GByteArray *array)
@@ -339,7 +339,7 @@
* Creates a new GMimeStreamMem object and initializes the stream
* contents with the first @len bytes of @buffer.
*
- * Returns a new memory stream initialized with @buffer.
+ * Returns: a new memory stream initialized with @buffer.
**/
GMimeStream *
g_mime_stream_mem_new_with_buffer (const char *buffer, size_t len)
@@ -364,7 +364,7 @@
*
* Gets the byte array from the memory stream.
*
- * Returns the byte array from the memory stream.
+ * Returns: the byte array from the memory stream.
**/
GByteArray *
g_mime_stream_mem_get_byte_array (GMimeStreamMem *mem)
@@ -413,7 +413,7 @@
*
* Gets whether or not @mem owns the backend memory buffer.
*
- * Returns %TRUE if @mem owns the backend memory buffer or %FALSE
+ * Returns: %TRUE if @mem owns the backend memory buffer or %FALSE
* otherwise.
**/
gboolean
Modified: trunk/gmime/gmime-stream-mmap.c
==============================================================================
--- trunk/gmime/gmime-stream-mmap.c (original)
+++ trunk/gmime/gmime-stream-mmap.c Sat May 31 19:35:13 2008
@@ -346,7 +346,7 @@
*
* Creates a new #GMimeStreamMmap object around @fd.
*
- * Returns a stream using @fd.
+ * Returns: a stream using @fd.
**/
GMimeStream *
g_mime_stream_mmap_new (int fd, int prot, int flags)
@@ -395,7 +395,7 @@
* Creates a new #GMimeStreamMmap object around @fd with bounds @start
* and @end.
*
- * Returns a stream using @fd with bounds @start and @end.
+ * Returns: a stream using @fd with bounds @start and @end.
**/
GMimeStream *
g_mime_stream_mmap_new_with_bounds (int fd, int prot, int flags, gint64 start, gint64 end)
Modified: trunk/gmime/gmime-stream-null.c
==============================================================================
--- trunk/gmime/gmime-stream-null.c (original)
+++ trunk/gmime/gmime-stream-null.c Sat May 31 19:35:13 2008
@@ -241,7 +241,7 @@
*
* Creates a new GMimeStreamNull object.
*
- * Returns a new null stream (similar to /dev/null on Unix).
+ * Returns: a new null stream (similar to /dev/null on Unix).
**/
GMimeStream *
g_mime_stream_null_new (void)
Modified: trunk/gmime/gmime-stream.c
==============================================================================
--- trunk/gmime/gmime-stream.c (original)
+++ trunk/gmime/gmime-stream.c Sat May 31 19:35:13 2008
@@ -163,7 +163,7 @@
*
* Attempts to read up to @len bytes from @stream into @buf.
*
- * Returns the number of bytes read or %-1 on fail.
+ * Returns: the number of bytes read or %-1 on fail.
**/
ssize_t
g_mime_stream_read (GMimeStream *stream, char *buf, size_t len)
@@ -194,7 +194,7 @@
*
* Attempts to write up to @len bytes of @buf to @stream.
*
- * Returns the number of bytes written or %-1 on fail.
+ * Returns: the number of bytes written or %-1 on fail.
**/
ssize_t
g_mime_stream_write (GMimeStream *stream, const char *buf, size_t len)
@@ -223,7 +223,7 @@
*
* Sync's the stream to disk.
*
- * Returns %0 on success or %-1 on fail.
+ * Returns: %0 on success or %-1 on fail.
**/
int
g_mime_stream_flush (GMimeStream *stream)
@@ -248,7 +248,7 @@
*
* Closes the stream.
*
- * Returns %0 on success or %-1 on fail.
+ * Returns: %0 on success or %-1 on fail.
**/
int
g_mime_stream_close (GMimeStream *stream)
@@ -273,7 +273,7 @@
*
* Tests the end-of-stream indicator for @stream.
*
- * Returns %TRUE on EOS or %FALSE otherwise.
+ * Returns: %TRUE on EOS or %FALSE otherwise.
**/
gboolean
g_mime_stream_eos (GMimeStream *stream)
@@ -301,7 +301,7 @@
*
* Resets the stream.
*
- * Returns %0 on success or %-1 on fail.
+ * Returns: %0 on success or %-1 on fail.
**/
int
g_mime_stream_reset (GMimeStream *stream)
@@ -344,7 +344,7 @@
* #GMIME_STREAM_SEEK_END: Seek @offset bytes relative to the
* end of the stream (bound_end if non-negative).
*
- * Returns the resultant position on success or %-1 on fail.
+ * Returns: the resultant position on success or %-1 on fail.
**/
gint64
g_mime_stream_seek (GMimeStream *stream, gint64 offset, GMimeSeekWhence whence)
@@ -369,7 +369,7 @@
*
* Gets the current offset within the stream.
*
- * Returns the current position within the stream or %-1 on fail.
+ * Returns: the current position within the stream or %-1 on fail.
**/
gint64
g_mime_stream_tell (GMimeStream *stream)
@@ -394,7 +394,7 @@
*
* Gets the length of the stream.
*
- * Returns the length of the stream or %-1 if unknown.
+ * Returns: the length of the stream or %-1 if unknown.
**/
ssize_t
g_mime_stream_length (GMimeStream *stream)
@@ -421,7 +421,7 @@
*
* Creates a new substream of @stream with bounds @start and @end.
*
- * Returns a substream of @stream with bounds @start and @end.
+ * Returns: a substream of @stream with bounds @start and @end.
**/
GMimeStream *
g_mime_stream_substream (GMimeStream *stream, gint64 start, gint64 end)
@@ -469,7 +469,7 @@
*
* Writes @string to @stream.
*
- * Returns the number of bytes written or %-1 on fail.
+ * Returns: the number of bytes written or %-1 on fail.
**/
ssize_t
g_mime_stream_write_string (GMimeStream *stream, const char *str)
@@ -489,7 +489,7 @@
*
* Write formatted output to a stream.
*
- * Returns the number of bytes written or %-1 on fail.
+ * Returns: the number of bytes written or %-1 on fail.
**/
ssize_t
g_mime_stream_printf (GMimeStream *stream, const char *fmt, ...)
@@ -522,7 +522,7 @@
*
* Attempts to write stream @src to stream @dest.
*
- * Returns the number of bytes written or %-1 on fail.
+ * Returns: the number of bytes written or %-1 on fail.
**/
ssize_t
g_mime_stream_write_to_stream (GMimeStream *src, GMimeStream *dest)
@@ -564,7 +564,7 @@
*
* Writes at most @count blocks described by @vector to @stream.
*
- * Returns the number of bytes written or %-1 on fail.
+ * Returns: the number of bytes written or %-1 on fail.
**/
ssize_t
g_mime_stream_writev (GMimeStream *stream, GMimeStreamIOVector *vector, size_t count)
Modified: trunk/gmime/gmime-utils.c
==============================================================================
--- trunk/gmime/gmime-utils.c (original)
+++ trunk/gmime/gmime-utils.c Sat May 31 19:35:13 2008
@@ -152,7 +152,7 @@
* Allocates a string buffer containing the rfc822 formatted date
* string represented by @time and @offset.
*
- * Returns a valid string representation of the date.
+ * Returns: a valid string representation of the date.
**/
char *
g_mime_utils_header_format_date (time_t date, int tz_offset)
@@ -696,7 +696,7 @@
* Decodes the rfc822 date string and saves the GMT offset into
* @saveoffset if non-NULL.
*
- * Returns the time_t representation of the date string specified by
+ * Returns: the time_t representation of the date string specified by
* @str. If 'saveoffset' is non-NULL, the value of the timezone offset
* will be stored.
**/
@@ -733,7 +733,7 @@
*
* Generates a unique Message-Id.
*
- * Returns a unique string in an addr-spec format suitable for use as
+ * Returns: a unique string in an addr-spec format suitable for use as
* a Message-Id.
**/
char *
@@ -928,7 +928,7 @@
*
* Decodes a msg-id as defined by rfc822.
*
- * Returns the addr-spec portion of the msg-id.
+ * Returns: the addr-spec portion of the msg-id.
**/
char *
g_mime_utils_decode_message_id (const char *message_id)
@@ -946,7 +946,7 @@
* Decodes a list of msg-ids as in the References and/or In-Reply-To
* headers defined in rfc822.
*
- * Returns a list of referenced msg-ids.
+ * Returns: a list of referenced msg-ids.
**/
GMimeReferences *
g_mime_references_decode (const char *text)
@@ -1057,7 +1057,7 @@
*
* Advances to the next reference node in the #GMimeReferences list.
*
- * Returns the next reference node in the #GMimeReferences list.
+ * Returns: the next reference node in the #GMimeReferences list.
**/
const GMimeReferences *
g_mime_references_get_next (const GMimeReferences *ref)
@@ -1072,7 +1072,7 @@
*
* Gets the Message-Id reference from the #GMimeReferences node.
*
- * Returns the Message-Id reference from the #GMimeReferences node.
+ * Returns: the Message-Id reference from the #GMimeReferences node.
**/
const char *
g_mime_references_get_message_id (const GMimeReferences *ref)
@@ -1201,7 +1201,7 @@
*
* Folds a structured header according to the rules in rfc822.
*
- * Returns an allocated string containing the folded header.
+ * Returns: an allocated string containing the folded header.
**/
char *
g_mime_utils_structured_header_fold (const char *str)
@@ -1216,7 +1216,7 @@
*
* Folds an unstructured header according to the rules in rfc822.
*
- * Returns an allocated string containing the folded header.
+ * Returns: an allocated string containing the folded header.
**/
char *
g_mime_utils_unstructured_header_fold (const char *str)
@@ -1231,7 +1231,7 @@
*
* Folds a structured header according to the rules in rfc822.
*
- * Returns an allocated string containing the folded header.
+ * Returns: an allocated string containing the folded header.
**/
char *
g_mime_utils_header_fold (const char *str)
@@ -1248,7 +1248,7 @@
* Allocates a buffer containing a formatted header specified by the
* @Varargs.
*
- * Returns an allocated string containing the folded header specified
+ * Returns: an allocated string containing the folded header specified
* by @format and the following arguments.
**/
char *
@@ -1296,7 +1296,7 @@
*
* Quotes @string as needed according to the rules in rfc2045.
*
- * Returns an allocated string containing the escaped and quoted (if
+ * Returns: an allocated string containing the escaped and quoted (if
* needed to be) input string. The decision to quote the string is
* based on whether or not the input string contains any 'tspecials'
* as defined by rfc2045.
@@ -1381,7 +1381,7 @@
* Determines if @text contains 8bit characters within the first @len
* bytes.
*
- * Returns %TRUE if the text contains 8bit characters or %FALSE
+ * Returns: %TRUE if the text contains 8bit characters or %FALSE
* otherwise.
**/
gboolean
@@ -1409,7 +1409,7 @@
* Determines the best content encoding for the first @len bytes of
* @text.
*
- * Returns a #GMimeContentEncoding that is determined to be the best
+ * Returns: a #GMimeContentEncoding that is determined to be the best
* encoding type for the specified block of text. ("best" in this
* particular case means smallest output size)
**/
@@ -1454,7 +1454,7 @@
* pre-allocated buffer of length * outlenp This is done so that the
* same output buffer can be reused multiple times.
*
- * Returns the string length of the output buffer.
+ * Returns: the string length of the output buffer.
**/
static size_t
charset_convert (iconv_t cd, const char *inbuf, size_t inleft, char **outp, size_t *outlenp, size_t *ninval)
@@ -1523,7 +1523,7 @@
* it will choose the best match and convert invalid byte sequences
* into question-marks (?) in the returned string buffer.
*
- * Returns a UTF-8 string representation of @text.
+ * Returns: a UTF-8 string representation of @text.
**/
char *
g_mime_utils_decode_8bit (const char *text, size_t len)
@@ -1781,7 +1781,7 @@
* conversion is handled for unencoded 8bit text and/or wrongly
* specified rfc2047 encoded-word tokens.
*
- * Returns a newly allocated UTF-8 string representing the the decoded
+ * Returns: a newly allocated UTF-8 string representing the the decoded
* header.
**/
char *
@@ -1909,7 +1909,7 @@
* conversion is handled for unencoded 8bit text and/or wrongly
* specified rfc2047 encoded-word tokens.
*
- * Returns a newly allocated UTF-8 string representing the the decoded
+ * Returns: a newly allocated UTF-8 string representing the the decoded
* header.
**/
char *
@@ -2435,7 +2435,7 @@
*
* Encodes a 'phrase' header according to the rules in rfc2047.
*
- * Returns the encoded 'phrase'. Useful for encoding internet
+ * Returns: the encoded 'phrase'. Useful for encoding internet
* addresses.
**/
char *
@@ -2454,7 +2454,7 @@
*
* Encodes a 'text' header according to the rules in rfc2047.
*
- * Returns the encoded header. Useful for encoding
+ * Returns: the encoded header. Useful for encoding
* headers like "Subject".
**/
char *
Modified: trunk/gmime/gmime.c
==============================================================================
--- trunk/gmime/gmime.c (original)
+++ trunk/gmime/gmime.c Sat May 31 19:35:13 2008
@@ -58,7 +58,7 @@
* Checks that the GMime library version meets the requirements of the
* required version.
*
- * Returns %TRUE if the requirement is met or %FALSE otherwise.
+ * Returns: %TRUE if the requirement is met or %FALSE otherwise.
**/
gboolean
g_mime_check_version (guint major, guint minor, guint micro)
Modified: trunk/gmime/internet-address.c
==============================================================================
--- trunk/gmime/internet-address.c (original)
+++ trunk/gmime/internet-address.c Sat May 31 19:35:13 2008
@@ -59,7 +59,7 @@
*
* Creates a new #InternetAddress object
*
- * Returns a new #InternetAddress object.
+ * Returns: a new #InternetAddress object.
**/
InternetAddress *
internet_address_new (void)
@@ -135,7 +135,7 @@
* Creates a new #InternetAddress object with name @name and address
* @addr.
*
- * Returns a new #InternetAddress object.
+ * Returns: a new #InternetAddress object.
**/
InternetAddress *
internet_address_new_name (const char *name, const char *addr)
@@ -162,7 +162,7 @@
*
* Creates a new #InternetAddress object with group name @name.
*
- * Returns a new #InternetAddress object.
+ * Returns: a new #InternetAddress object.
**/
InternetAddress *
internet_address_new_group (const char *name)
@@ -265,7 +265,7 @@
* Gets the type of the internet address, which will either be
* #INTERNET_ADDRESS_NAME or #INTERNET_ADDRESS_GROUP.
*
- * Returns the type of @ia.
+ * Returns: the type of @ia.
**/
InternetAddressType
internet_address_get_type (InternetAddress *ia)
@@ -282,7 +282,7 @@
* Gets the name component of the internet address. If the internet
* address is a group, it will get the group name.
*
- * Returns the name of @ia.
+ * Returns: the name of @ia.
**/
const char *
internet_address_get_name (InternetAddress *ia)
@@ -299,7 +299,7 @@
*
* Gets the addr-spec of the internet address.
*
- * Returns the address of @ia.
+ * Returns: the address of @ia.
**/
const char *
internet_address_get_addr (InternetAddress *ia)
@@ -318,7 +318,7 @@
* Gets the #InternetAddressList containing the group members of an
* rfc822 group address.
*
- * Returns the members of @ia.
+ * Returns: the members of @ia.
**/
const InternetAddressList *
internet_address_get_members (InternetAddress *ia)
@@ -338,7 +338,7 @@
* Prepends the internet address @ia to the list of internet addresses
* pointed to by @list.
*
- * Returns the resultant list.
+ * Returns: the resultant list.
**/
InternetAddressList *
internet_address_list_prepend (InternetAddressList *list, InternetAddress *ia)
@@ -364,7 +364,7 @@
* Appends the internet address to the list of internet addresses
* pointed to by @list.
*
- * Returns the resultant list.
+ * Returns: the resultant list.
**/
InternetAddressList *
internet_address_list_append (InternetAddressList *list, InternetAddress *ia)
@@ -398,7 +398,7 @@
*
* Concatenates a copy of list @b onto the end of list @a.
*
- * Returns the resulting list.
+ * Returns: the resulting list.
**/
InternetAddressList *
internet_address_list_concat (InternetAddressList *a, InternetAddressList *b)
@@ -440,7 +440,7 @@
*
* Advances to the next address node in the #InternetAddessList.
*
- * Returns the next address node in the #InternetAddessList.
+ * Returns: the next address node in the #InternetAddessList.
**/
InternetAddressList *
internet_address_list_next (const InternetAddressList *list)
@@ -455,7 +455,7 @@
*
* Gets the #InternetAddress currently pointed to in @list.
*
- * Returns the #InternetAddress currently pointed to in @list.
+ * Returns: the #InternetAddress currently pointed to in @list.
**/
InternetAddress *
internet_address_list_get_address (const InternetAddressList *list)
@@ -469,7 +469,7 @@
*
* Calculates the length of the list of addresses.
*
- * Returns the number of internet addresses in @list.
+ * Returns: the number of internet addresses in @list.
**/
int
internet_address_list_length (const InternetAddressList *list)
@@ -700,7 +700,7 @@
* Allocates a string containing the contents of the #InternetAddress
* object.
*
- * Returns the #InternetAddress object as an allocated string in
+ * Returns: the #InternetAddress object as an allocated string in
* rfc822 format.
**/
char *
@@ -729,7 +729,7 @@
* Allocates a string buffer containing the rfc822 formatted addresses
* in @list.
*
- * Returns a string containing the list of addresses in rfc822 format.
+ * Returns: a string containing the list of addresses in rfc822 format.
**/
char *
internet_address_list_to_string (const InternetAddressList *list, gboolean encode)
@@ -1008,7 +1008,7 @@
*
* Construct a list of internet addresses from the given string.
*
- * Returns a linked list of internet addresses. *Must* be free'd by
+ * Returns: a linked list of internet addresses. *Must* be free'd by
* the caller.
**/
InternetAddressList *
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
