alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

* mu-msg-doc: cosmetics, documentation

Browse Source
This commit is contained in:
Dirk-Jan C. Binnema
2011-06-18 18:42:24 +03:00
parent 8000b85f89
commit b08bf4a1ed
2 changed files with 14 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/mu-msg-doc.h
View File

@ -33,13 +33,14 @@ typedef struct _MuMsgDoc MuMsgDoc;
*
* @param doc a Xapian::Document* (you'll need to cast the
* Xapian::Document* to XapianDocument*, because only C (not C++) is
* allowed in this header file.
* allowed in this header file. MuMsgDoc takes _ownership_ of this pointer;
* don't touch it afterwards
* @param err receives error info, or NULL
*
* @return a new MuMsgDoc instance (free with mu_msg_doc_destroy), or
* NULL in case of error.
*/
MuMsgDoc* mu_msg_doc_new (const XapianDocument *doc, GError **err)
MuMsgDoc* mu_msg_doc_new (XapianDocument *doc, GError **err)
G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
/**
@ -65,7 +66,8 @@ void mu_msg_doc_destroy (MuMsgDoc *self);
*
* @return a string for the given field (see do_free), or NULL in case of error
*/
gchar* mu_msg_doc_get_str_field (MuMsgDoc *self, MuMsgFieldId mfid, gboolean *do_free)
gchar* mu_msg_doc_get_str_field (MuMsgDoc *self, MuMsgFieldId mfid,
gboolean *do_free)
G_GNUC_WARN_UNUSED_RESULT;
/**