From 9faf4b4e9eac13ceb9d8c214554d5ee2a384dc28 Mon Sep 17 00:00:00 2001 From: Giovanni Campagna Date: Fri, 22 Feb 2013 01:50:48 +0100 Subject: GIRepository: add API for extending library paths Previously we would require applications that shipped with private typelibs to add the private path to LD_LIBRARY_PATH, or to have a launcher binary with the right RPATH. Now they can just call GIRepository.prepend_library_path() before they access the module. https://bugzilla.gnome.org/show_bug.cgi?id=694485 --- girepository/girepository.h | 1 + 1 file changed, 1 insertion(+) (limited to 'girepository/girepository.h') diff --git a/girepository/girepository.h b/girepository/girepository.h index eb990a27..2b2b1713 100644 --- a/girepository/girepository.h +++ b/girepository/girepository.h @@ -90,6 +90,7 @@ typedef enum GType g_irepository_get_type (void) G_GNUC_CONST; GIRepository *g_irepository_get_default (void); void g_irepository_prepend_search_path (const char *directory); +void g_irepository_prepend_library_path (const char *directory); GSList * g_irepository_get_search_path (void); const char * g_irepository_load_typelib (GIRepository *repository, GITypelib *typelib, -- cgit v1.2.1 From a737daa16e458e87f189c2535f11f4bd2dde8f1a Mon Sep 17 00:00:00 2001 From: Dieter Verfaillie Date: Thu, 10 Oct 2013 22:21:18 +0200 Subject: docs: fix up reference docs a bit - require GTK-Doc 1.19 - remove sgml mode - automatically generate gi.types (needs GTK-Doc 1.19) - fix https://bugzilla.gnome.org/show_bug.cgi?id=700025 [WIP] - rearange sections a bit [WIP] - add gi-building, gi-programming sections [WIP] - mark missing docs with TODO, which is only marginaly better than nothing but at least can be grepped :) https://bugzilla.gnome.org/show_bug.cgi?id=571648 --- girepository/girepository.h | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) (limited to 'girepository/girepository.h') diff --git a/girepository/girepository.h b/girepository/girepository.h index 2b2b1713..dea250df 100644 --- a/girepository/girepository.h +++ b/girepository/girepository.h @@ -56,29 +56,34 @@ G_BEGIN_DECLS #define G_IS_IREPOSITORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), G_TYPE_IREPOSITORY)) #define G_IREPOSITORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), G_TYPE_IREPOSITORY, GIRepositoryClass)) +/** + * GIRepository: + * + * The GIRepository structure contains private data and should only be + * accessed using the provided API. + */ typedef struct _GIRepository GIRepository; typedef struct _GIRepositoryClass GIRepositoryClass; typedef struct _GIRepositoryPrivate GIRepositoryPrivate; struct _GIRepository { - GObject parent; - /*< private >*/ + GObject parent; GIRepositoryPrivate *priv; }; struct _GIRepositoryClass { + /*< private >*/ GObjectClass parent; }; /** * GIRepositoryLoadFlags: - * @G_IREPOSITORY_LOAD_FLAG_LAZY: Load the types lazily. + * @G_IREPOSITORY_LOAD_FLAG_LAZY: Lazily load the typelib. * - * Flags that controlls how a typelib is loaded by - * GIRepositry, used by g_irepository_load_typelib(). + * Flags that control how a typelib is loaded. */ typedef enum { @@ -144,11 +149,14 @@ gboolean g_irepository_dump (const char *arg, GError **error); * GIRepositoryError: * @G_IREPOSITORY_ERROR_TYPELIB_NOT_FOUND: the typelib could not be found. * @G_IREPOSITORY_ERROR_NAMESPACE_MISMATCH: the namespace does not match the - * requested namespace. + * requested namespace. * @G_IREPOSITORY_ERROR_NAMESPACE_VERSION_CONFLICT: the version of the - * typelib does not match the requested version. + * typelib does not match the requested version. * @G_IREPOSITORY_ERROR_LIBRARY_NOT_FOUND: the library used by the typelib - * could not be found. + * could not be found. + * + * An error code used with #G_IREPOSITORY_ERROR in a #GError returned + * from a #GIRepository routine. */ typedef enum { @@ -158,6 +166,13 @@ typedef enum G_IREPOSITORY_ERROR_LIBRARY_NOT_FOUND } GIRepositoryError; +/** + * G_IREPOSITORY_ERROR: + * + * Error domain for #GIRepository. Errors in this domain will be from the + * #GIRepositoryError enumeration. See #GError for more information on + * error domains. + */ #define G_IREPOSITORY_ERROR (g_irepository_error_quark ()) GQuark g_irepository_error_quark (void); -- cgit v1.2.1