[gmime] updated docs
- From: Jeffrey Stedfast <fejj src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gmime] updated docs
- Date: Sat, 30 Oct 2010 15:03:02 +0000 (UTC)
commit 4c9de808f875ba8e458fded3ba7e2443402f2981
Author: Jeffrey Stedfast <fejj gnome org>
Date: Sat Oct 30 11:02:52 2010 -0400
updated docs
ChangeLog | 6 +++---
docs/reference/gmime-sections.txt | 1 +
gmime/gmime-message.c | 6 +++---
gmime/gmime-stream.h | 2 +-
gmime/internet-address.c | 10 ++++------
5 files changed, 12 insertions(+), 13 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 576bfea..2ecf324 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,8 +1,8 @@
2010-10-30 Jeffrey Stedfast <fejj novell com>
- * gmime/gmime-message.c (g_mime_message_guess_body): New function
- to try and guess which part (or multipart/alternative) represents
- the message body.
+ * gmime/gmime-message.c (g_mime_message_get_body): New function to
+ try and guess which part (or multipart/alternative) represents the
+ message body.
2010-09-25 Jeffrey Stedfast <fejj novell com>
diff --git a/docs/reference/gmime-sections.txt b/docs/reference/gmime-sections.txt
index 70b1c8b..706a71f 100644
--- a/docs/reference/gmime-sections.txt
+++ b/docs/reference/gmime-sections.txt
@@ -846,6 +846,7 @@ g_mime_message_get_message_id
g_mime_message_set_mime_part
g_mime_message_get_mime_part
g_mime_message_foreach
+g_mime_message_get_body
<SUBSECTION Private>
g_mime_message_get_type
diff --git a/gmime/gmime-message.c b/gmime/gmime-message.c
index 0051873..418a096 100644
--- a/gmime/gmime-message.c
+++ b/gmime/gmime-message.c
@@ -1021,7 +1021,7 @@ message_encode (GMimeObject *object, GMimeEncodingConstraint constraint)
/**
- * g_mime_message_new: Create a new MIME Message object
+ * g_mime_message_new:
* @pretty_headers: make pretty headers
*
* If @pretty_headers is %TRUE, then the standard rfc822 headers are
@@ -1029,7 +1029,7 @@ message_encode (GMimeObject *object, GMimeEncodingConstraint constraint)
* 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 #GMimeMessage object.
**/
GMimeMessage *
g_mime_message_new (gboolean pretty_headers)
@@ -1583,7 +1583,7 @@ multipart_guess_body (GMimeMultipart *multipart)
* recommended that you traverse the MIME structure yourself.
**/
GMimeObject *
-g_mime_message_guess_body (GMimeMessage *message)
+g_mime_message_get_body (GMimeMessage *message)
{
GMimeObject *mime_part;
diff --git a/gmime/gmime-stream.h b/gmime/gmime-stream.h
index 82418f5..90f0fa5 100644
--- a/gmime/gmime-stream.h
+++ b/gmime/gmime-stream.h
@@ -74,7 +74,7 @@ typedef struct {
* GMimeStream:
* @parent_object: parent #GObject
* @super_stream: parent stream if this is a substream
- * @position: the current stream position (aka offset)
+ * @position: the current stream position
* @bound_start: start boundary of the stream
* @bound_end: end boundary of the stream
*
diff --git a/gmime/internet-address.c b/gmime/internet-address.c
index b7bfaeb..73915e1 100644
--- a/gmime/internet-address.c
+++ b/gmime/internet-address.c
@@ -1387,11 +1387,10 @@ decode_address (const char **in)
name = g_string_new ("");
- /**
- * Both groups and mailboxes can begin with a phrase (denoting
+ /* Both groups and mailboxes can begin with a phrase (denoting
* the display name for the address). Collect all of the
* tokens that make up this name phrase.
- **/
+ */
while (*inptr) {
if ((word = decode_word (&inptr)))
g_string_append_len (name, word, (size_t) (inptr - word));
@@ -1413,11 +1412,10 @@ decode_address (const char **in)
continue;
}
- /**
- * specials = "(" / ")" / "<" / ">" / "@" ; Must be in quoted-
+ /* specials = "(" / ")" / "<" / ">" / "@" ; Must be in quoted-
* / "," / ";" / ":" / "\" / <"> ; string, to use
* / "." / "[" / "]" ; within a word.
- **/
+ */
if (*inptr == ':') {
/* group */
inptr++;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]