From 19a0c1c47879ee37cf818e9706b1133c3c9c318e Mon Sep 17 00:00:00 2001 From: djcb Date: Tue, 25 Dec 2012 16:44:26 +0200 Subject: [PATCH] * mu-msg, mu-msg-file: update doc for get_references a bit --- lib/mu-msg-file.c | 5 +++++ lib/mu-msg.h | 9 ++++----- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/mu-msg-file.c b/lib/mu-msg-file.c index d4065470..a2bf275d 100644 --- a/lib/mu-msg-file.c +++ b/lib/mu-msg-file.c @@ -486,6 +486,9 @@ contains (GSList *lst, const char *str) } +/* + * NOTE: this will get the list of references with the oldest parent + * at the beginning */ static GSList* get_references (MuMsgFile *self) { @@ -520,6 +523,8 @@ get_references (MuMsgFile *self) g_mime_references_free (mime_refs); } + /* reverse, because we used g_slist_prepend for performance + * reasons */ return g_slist_reverse (msgids); } diff --git a/lib/mu-msg.h b/lib/mu-msg.h index 50871b22..5b698991 100644 --- a/lib/mu-msg.h +++ b/lib/mu-msg.h @@ -390,12 +390,11 @@ time_t mu_msg_get_timestamp (MuMsg *msg); const char* mu_msg_get_header (MuMsg *self, const char *header); - /** - * get the list of references, with the direct parent as the final - * one; this final one is typically the 'In-reply-to' field. Note, any - * reference (message-id) will appear at most once, duplicates are - * filtered out. + * get the list of references (consisting of both the References and + * In-Reply-To fields), with the oldest first and the direct parent as + * the last one. Note, any reference (message-id) will appear at most + * once, duplicates are filtered out. * * @param msg a valid MuMsg *