* cosmetics
This commit is contained in:
@ -23,16 +23,25 @@
|
||||
#include <glib.h>
|
||||
|
||||
G_BEGIN_DECLS
|
||||
/**
|
||||
* @addtogroup MuBookmarks
|
||||
* Functions for dealing with bookmarks
|
||||
* @{
|
||||
*/
|
||||
|
||||
struct _MuBookmarks;
|
||||
/*! \struct MuBookmarks
|
||||
* \brief Opaque structure representing a sequence of bookmarks
|
||||
*/
|
||||
typedef struct _MuBookmarks MuBookmarks;
|
||||
|
||||
|
||||
/**
|
||||
* create a new bookmarks object. when it's no longer needed, use
|
||||
* mu_bookmarks_destroy
|
||||
*
|
||||
*
|
||||
* @param bmpath path to the bookmarks file
|
||||
*
|
||||
*
|
||||
* @return a new BookMarks object, or NULL in case of error
|
||||
*/
|
||||
MuBookmarks *mu_bookmarks_new (const gchar *bmpath)
|
||||
@ -40,7 +49,7 @@ MuBookmarks *mu_bookmarks_new (const gchar *bmpath)
|
||||
|
||||
/**
|
||||
* destroy a bookmarks object
|
||||
*
|
||||
*
|
||||
* @param bm a bookmarks object, or NULL
|
||||
*/
|
||||
void mu_bookmarks_destroy (MuBookmarks *bm);
|
||||
@ -48,10 +57,10 @@ void mu_bookmarks_destroy (MuBookmarks *bm);
|
||||
|
||||
/**
|
||||
* get the value for some bookmark
|
||||
*
|
||||
*
|
||||
* @param bm a valid bookmarks object
|
||||
* @param name name of the bookmark to retrieve
|
||||
*
|
||||
*
|
||||
* @return the value of the bookmark or NULL in case in error, e.g. if
|
||||
* the bookmark was not found
|
||||
*/
|
||||
@ -62,7 +71,7 @@ typedef void (*MuBookmarksForeachFunc) (const gchar *key, const gchar *val,
|
||||
|
||||
/**
|
||||
* call a function for each bookmark
|
||||
*
|
||||
*
|
||||
* @param bm a valid bookmarks object
|
||||
* @param func a callback function to be called for each bookmarks
|
||||
* @param user_data a user pointer passed to the callback
|
||||
@ -70,6 +79,8 @@ typedef void (*MuBookmarksForeachFunc) (const gchar *key, const gchar *val,
|
||||
void mu_bookmarks_foreach (MuBookmarks *bm, MuBookmarksForeachFunc func,
|
||||
gpointer user_data);
|
||||
|
||||
/** @} */
|
||||
|
||||
G_END_DECLS
|
||||
|
||||
#endif /*__MU_BOOKMARKS_H__*/
|
||||
|
||||
Reference in New Issue
Block a user