* mu-msg, mu-msg-file: update doc for get_references a bit

This commit is contained in:
djcb
2012-12-25 16:44:26 +02:00
parent a625371da2
commit 19a0c1c478
2 changed files with 9 additions and 5 deletions

View File

@ -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* static GSList*
get_references (MuMsgFile *self) get_references (MuMsgFile *self)
{ {
@ -520,6 +523,8 @@ get_references (MuMsgFile *self)
g_mime_references_free (mime_refs); g_mime_references_free (mime_refs);
} }
/* reverse, because we used g_slist_prepend for performance
* reasons */
return g_slist_reverse (msgids); return g_slist_reverse (msgids);
} }

View File

@ -390,12 +390,11 @@ time_t mu_msg_get_timestamp (MuMsg *msg);
const char* mu_msg_get_header (MuMsg *self, const char *header); const char* mu_msg_get_header (MuMsg *self, const char *header);
/** /**
* get the list of references, with the direct parent as the final * get the list of references (consisting of both the References and
* one; this final one is typically the 'In-reply-to' field. Note, any * In-Reply-To fields), with the oldest first and the direct parent as
* reference (message-id) will appear at most once, duplicates are * the last one. Note, any reference (message-id) will appear at most
* filtered out. * once, duplicates are filtered out.
* *
* @param msg a valid MuMsg * @param msg a valid MuMsg
* *