* cleanup some header files

This commit is contained in:
Dirk-Jan C. Binnema 2011-05-22 14:48:31 +03:00
parent 9454d31d50
commit abf9c632e3
5 changed files with 22 additions and 16 deletions

View File

@ -28,7 +28,7 @@ G_BEGIN_DECLS
struct _MuContacts; struct _MuContacts;
typedef struct _MuContacts MuContacts; typedef struct _MuContacts MuContacts;
/** /**
* create a new MuContacts object; use mu_contacts_destroy when you no longer need it * create a new MuContacts object; use mu_contacts_destroy when you no longer need it
* *
* @param ccachefile full path to the file with cached list of contacts * @param ccachefile full path to the file with cached list of contacts
@ -39,7 +39,7 @@ MuContacts* mu_contacts_new (const gchar* ccachefile)
G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT; G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
/** /**
* add a contacts; if there's a contact with this e-mail address * add a contacts; if there's a contact with this e-mail address
* already, it will not updated unless the timestamp of this one is * already, it will not updated unless the timestamp of this one is
* higher and has a non-empty name * higher and has a non-empty name
@ -55,14 +55,14 @@ gboolean mu_contacts_add (MuContacts *contacts, const char* name,
const char *email, const char *email,
time_t tstamp); time_t tstamp);
/** /**
* destroy the Contacts object * destroy the Contacts object
* *
* @param contacts a contacts object * @param contacts a contacts object
*/ */
void mu_contacts_destroy (MuContacts *contacts); void mu_contacts_destroy (MuContacts *contacts);
/** /**
* call called for mu_contacts_foreach; returns the e-mail address, * call called for mu_contacts_foreach; returns the e-mail address,
* name (which may be NULL) and the timestamp for the address * name (which may be NULL) and the timestamp for the address
* *
@ -70,7 +70,7 @@ void mu_contacts_destroy (MuContacts *contacts);
typedef void (*MuContactsForeachFunc) (const char *email, const char *name, typedef void (*MuContactsForeachFunc) (const char *email, const char *name,
time_t tstamp, gpointer user_data); time_t tstamp, gpointer user_data);
/** /**
* call a function for either each contact, or each contact satisfying * call a function for either each contact, or each contact satisfying
* a regular expression, * a regular expression,
* *

View File

@ -1,3 +1,5 @@
/* -*-mode: c; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-*/
/* /*
** Copyright (C) 2008-2011 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> ** Copyright (C) 2008-2011 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
** **

View File

@ -86,7 +86,7 @@ typedef struct _MuMsgPart MuMsgPart;
#define mu_msg_part_content_id(pi) ((pi)->content_id) #define mu_msg_part_content_id(pi) ((pi)->content_id)
/** /**
* does this msg part look like an attachment? * does this msg part look like an attachment?
* *
* @param part a message part * @param part a message part
@ -159,7 +159,7 @@ int mu_msg_part_find_cid (MuMsg *msg, const char* content_id);
* @param a regular expression to match the filename with * @param a regular expression to match the filename with
* *
* @return a list with indices for the files matching the pattern; the * @return a list with indices for the files matching the pattern; the
* indices are the GPOINTER_TO_UNIT(lst->data) of the list. The must * indices are the GPOINTER_TO_UINT(lst->data) of the list. The must
* be freed with g_slist_free * be freed with g_slist_free
*/ */
GSList* mu_msg_part_find_files (MuMsg *msg, const GRegex *pattern); GSList* mu_msg_part_find_files (MuMsg *msg, const GRegex *pattern);

View File

@ -1,3 +1,5 @@
/* -*-mode: c; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-*/
/* /*
** Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> ** Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
** **
@ -23,8 +25,8 @@
#include <time.h> #include <time.h>
#include <sys/types.h> #include <sys/types.h>
#include "mu-msg.h" #include <mu-msg.h>
#include "mu-msg-flags.h" #include <mu-msg-flags.h>
G_BEGIN_DECLS G_BEGIN_DECLS
@ -210,7 +212,7 @@ time_t mu_str_date_parse_hdwmy (const char* str);
/** /**
* parse a byte size; a size is a number, with optionally a * parse a byte size; a size is a number, with optionally a
* unit. Units recognized are K (1000) and M (1000*1000). Only the * unit. Units recognized are K (1000) and M (1000*1000). Only the
* first letter is checked and the function is not case-sensitive, so * first letter is checked and the function is not case-sensitive, so
@ -239,7 +241,7 @@ guint64 mu_str_size_parse_kmg (const char* str);
const char* mu_str_fullpath_s (const char* path, const char* name); const char* mu_str_fullpath_s (const char* path, const char* name);
/** /**
* escape a string like a string literal in C; ie. replace \ with \\, * escape a string like a string literal in C; ie. replace \ with \\,
* and " with \" * and " with \"
* *
@ -251,7 +253,7 @@ char* mu_str_escape_c_literal (const gchar* str)
G_GNUC_WARN_UNUSED_RESULT; G_GNUC_WARN_UNUSED_RESULT;
/** /**
* macro to check whether the string is empty, ie. if it's NULL or * macro to check whether the string is empty, ie. if it's NULL or
* it's length is 0 * it's length is 0
* *
@ -263,7 +265,7 @@ char* mu_str_escape_c_literal (const gchar* str)
/** /**
* guess some nick name for the given name; if we can determine an * guess some nick name for the given name; if we can determine an
* first name, last name, the nick will be first name + the first char * first name, last name, the nick will be first name + the first char
* of the last name. otherwise, it's just the first name. clearly, * of the last name. otherwise, it's just the first name. clearly,
@ -277,7 +279,7 @@ gchar* mu_str_guess_nick (const char* name)
G_GNUC_WARN_UNUSED_RESULT; G_GNUC_WARN_UNUSED_RESULT;
/** /**
* guess the first name for the given name; clearly, * guess the first name for the given name; clearly,
* this is just a rough guess for setting an initial value. * this is just a rough guess for setting an initial value.
* *
@ -291,7 +293,7 @@ gchar* mu_str_guess_first_name (const char* name)
/** /**
* guess the last name for the given name; clearly, * guess the last name for the given name; clearly,
* this is just a rough guess for setting an initial value. * this is just a rough guess for setting an initial value.
* *

View File

@ -1,3 +1,5 @@
/* -*-mode: c; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-*/
/* /*
** Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> ** Copyright (C) 2008-2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
** **
@ -184,7 +186,7 @@ gboolean mu_util_xapian_is_empty (const gchar *xpath);
gboolean mu_util_xapian_clear (const gchar *xpath); gboolean mu_util_xapian_clear (const gchar *xpath);
/** /**
* check if the database is locked for writing * check if the database is locked for writing
* *
* @param xpath path to a xapian database * @param xpath path to a xapian database