Switch library documentation to gi-docgen
Switch from gtk-doc to gi-docgen for the library documentation and adjust the source files accordingly. We don't bother about the daemon doc headers as they're not built into any docs atm. Closes: #56
This commit is contained in:
@@ -9,34 +9,6 @@
|
||||
|
||||
#include "lfb-names.h"
|
||||
|
||||
/**
|
||||
* SECTION:libfeedback
|
||||
* @Short_description: Library initialization and helpers
|
||||
* @Title: libfeedback
|
||||
*
|
||||
* To use the library call #lfb_init() with the id of your application
|
||||
* (usually the desktop file name without the .desktop extension).
|
||||
* After initializing the library you can trigger feedback using
|
||||
* #LfbEvent objects. When your application finishes call
|
||||
* #lfb_uninit() to free any resources:
|
||||
*
|
||||
* |[<!-- language="C" -->
|
||||
* #define LIBFEEDBACK_USE_UNSTABLE_API
|
||||
* #include <libfeedback.h>
|
||||
*
|
||||
* int main(void)
|
||||
* {
|
||||
* g_autoptr (GError) *err = NULL;
|
||||
* if (lfb_init ("com.example.appid", &err)) {
|
||||
* g_error ("%s", err->message);
|
||||
* }
|
||||
* ...
|
||||
* lfb_uninit ();
|
||||
* return 0;
|
||||
* }
|
||||
* ]|
|
||||
*/
|
||||
|
||||
static LfbGdbusFeedback *_proxy;
|
||||
static char *_app_id;
|
||||
static gboolean _initted;
|
||||
@@ -99,7 +71,7 @@ _lfb_get_proxy (void)
|
||||
* @app_id: The application id
|
||||
* @error: Error information
|
||||
*
|
||||
* Initialize libfeedback. This must be called before any other functions.
|
||||
* Initialize libfeedback. This must be called before any other of libfeedback's functions.
|
||||
*
|
||||
* Returns: %TRUE if successful, or %FALSE on error.
|
||||
*/
|
||||
@@ -159,6 +131,8 @@ lfb_set_app_id (const char *app_id)
|
||||
/**
|
||||
* lfb_get_app_id:
|
||||
*
|
||||
* Get the application id set via [func@Lfb.set_app_id]().
|
||||
*
|
||||
* Returns: the application id.
|
||||
*/
|
||||
const gchar *
|
||||
|
||||
Reference in New Issue
Block a user