summaryrefslogtreecommitdiff
path: root/docs/reference
Commit message (Collapse)AuthorAgeFilesLines
* docs: Add missing versioned indicesEmmanuele Bassi2022-02-131-0/+16
| | | | | It's pointless, as docbook's style sheets do not work any more, but gtk-doc still warns about them.
* docs: Add missing symbols to the sections fileEmmanuele Bassi2022-02-131-0/+19
|
* docs: Point to the GitLab page for libgrepository's API referenceEmmanuele Bassi2021-11-071-2/+2
| | | | | Do not use the snapshot of the old developer.gnome.org website; we generate and publish the API reference ourselves.
* Add introspection data for property accessorsEmmanuele Bassi2021-08-051-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A GObject property can be accessed generically through the GObject API, e.g. g_object_set_property() and g_object_get_property(). Properties typically also have public accessor functions, which are (according to our own best practices) called through the generic API. The introspection data is currently missing the relation between a property and its public accessor functions. With this information, a language binding could, for instance, avoid exposing the C API entirely, thus minimizing the chances of collisions between property names and accessor functions; alternatively, a binding could call the C API directly instead of going through the generic GObject API, thus avoiding the boxing and unboxing from a native type to a GIArgument and finally into a GValue, and vice versa. In the GIR, we add two new attributes to the `property` element: - setter="SYMBOL" - getter="SYMBOL" where "symbol" is the C function identifier of the setter and getter functions, respectively. The `setter` attribute is only applied to writable, non-construct-only properties; the `getter` attribute is only applied to readable properties. We maintain the ABI compatibility of the typelib data by using 20 bits of the 25 reserved bits inside the PropertyBlob structure. The data is exposed through two new GIPropertyInfo methods: - g_property_info_get_setter() - g_property_info_get_getter() which return the GIFunctionInfo for the setter and getter functions, respectively.
* Add newly added girepository symbol to the API referenceEmmanuele Bassi2021-08-051-0/+1
|
* Update the developer.gnome.org URLsEmmanuele Bassi2021-08-051-1/+1
| | | | | | | The GNOME developers documentation website has been updated, and we're in the process of moving API references elsewhere. The old documentation is still available under developer-old.gnome.org, so let's update the URLs we have in our documentation.
* docs: Unify DocBook doctypeJan Tojnar2020-05-151-2/+2
| | | | | | | There has been no backwards incompatible changes between DockBook 4.3 and 4.5 so there is no need to use both. Ideally, we would switch to DocBook 5 but that will require more changes.
* Drop autotools build systemChristoph Reiter2019-03-111-115/+0
|
* repository: g_irepository_get_object_gtype_interfacesColin Walters2019-01-091-0/+2
| | | | | | | | | | | Bindings in some cases need to look up information from a GType dynamically. Support that better by supplying a cache for this information. (Rebased and versioning / gtk-doc stuff added by Philip Chimento.) Closes #38. See gjs#55.
* autotools: fix missing version api in gtk-doc for non-srcdir buildsChristoph Reiter2019-01-011-2/+2
| | | | | | Properly pass the build dir paths to gtk-doc so it can find things in giversion.h This fixes the version section being empty when building the docs with non-srcdir autotools.
* girepository: Add version macros and functions. Fixes #200Christoph Reiter2018-12-162-0/+17
| | | | | | | | | | | This adds the following macros and functions: GI_MAJOR_VERSION, GI_MICRO_VERSION, GI_MINOR_VERSION, GI_CHECK_VERSION, gi_get_major_version,gi_get_micro_version, gi_get_minor_version. Since we share a prefix with glib we have to namespace these by using the gi_ prefix. g_gi would also work but we already export symbols with gi_ like gi_cclosure_marshal_generic(), gi_type_tag_get_ffi_type() and gi_type_info_extract_ffi_return_value(), so let's not add another naming scheme.
* docs: move g_type_tag_to_string() and g_info_type_to_string() to the right ↵Christoph Reiter2018-12-141-2/+2
| | | | | | section Move them to where the type is documented.
* docs: Remove everything not related to libgirepository and restructure. ↵Christoph Reiter2018-12-1410-900/+25
| | | | | | | | | | | | | Fixes #244 The gtk-doc docs were including some bits of overal g-i docs but mostly unfinished and outdated. We now have the general docs in sphinx so remove the duplication and make the gtk-docs just about the libgirepository API and nothing more. This also renames some titles and fixes some missing links in the struct hierarchy while at it.
* docs: fix gtk-doc warnings and update version infosChristoph Reiter2018-12-094-66/+58
| | | | | | | | Move things around and rename things until gtk-doc is happy. This also moves the "Since" annotations to the next stable releases and adds version added info for g_callable_info_get_instance_ownership_transfer() and g_struct_info_find_field().
* autotools: dist all meson filesChristoph Reiter2018-06-211-1/+3
|
* Build docsPatrick Griffis2018-03-101-0/+41
|
* removing $(srcdir) because it is not replaced correctly and not necessaryKarl-Philipp Richter2018-02-081-1/+1
| | | | See #120.
* Revert "removing $(srcdir) because it is not replaced correctly and not ↵Emmanuele Bassi2017-05-041-1/+1
| | | | | | | | necessary" This reverts commit 17ef691e9b3ebd475b01d1e623d3df7b1f534dfa. This breaks builddir != srcdir builds, like GNOME Continuous.
* removing $(srcdir) because it is not replaced correctly and not necessaryKarl-Philipp Richter2017-05-041-1/+1
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=744021
* docs: Clarify that GIR files may contain installation-specific dataPhilip Withnall2015-03-131-1/+3
| | | | | | Such as library filenames. https://bugzilla.gnome.org/show_bug.cgi?id=746138
* girepository: Add g_irepository_get_immediate_dependencies()Philip Withnall2015-02-161-0/+1
| | | | | | | | | | | | | | | | g_irepository_get_dependencies() is supposed to return the transitive closure of all dependencies of the given namespace. However, it just loads the dependencies field from the typelib, which is supposed to only list immediate dependencies. Introduce a new g_irepository_get_immediate_dependencies() which does this, and rewrite g_irepository_get_dependencies() to build the transitive closure of all its namespace dependencies. This does not require loading any new typelibs, as the transitive closure of dependencies should already have been loaded by g_irepository_require() or g_irepository_load_typelib(). https://bugzilla.gnome.org/show_bug.cgi?id=743782
* comment about generation of gtk-doc.make in autogen.shKarl-Philipp Richter2015-02-131-1/+1
|
* docs: fix up reference docs a bitDieter Verfaillie2013-10-1012-487/+830
| | | | | | | | | | | | | - 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: remove glib-compatDieter Verfaillie2013-10-091-1/+0
| | | | | We depend on glib-2.0 >= 2.36.0, so no need to keep a 2.22.X compatibility symbol around...
* docs: Update Makefile.amDieter Verfaillie2013-10-081-1/+1
|
* GIRepository: add API for extending library pathsGiovanni Campagna2013-02-241-0/+1
| | | | | | | | | | 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
* docs: remove reference to object_grouped.sgml.Dieter Verfaillie2012-11-153-3/+0
| | | | | | | This most likely sneaked in as a copy paste error from GTK+ reference docs as g-i never had a object_grouped.sgml... https://bugzilla.gnome.org/show_bug.cgi?id=688418
* docs: make gtkdoc-mkdb ignore cmph doxygen comment blocks.Dieter Verfaillie2012-11-151-1/+1
| | | | | | | | | When building g-i reference documentation, girepository/cmph/* was being scanned for GTK-Doc comment blocks by gtkdoc-mkdb. Unfortunately, cmph uses doxygen comment blocks which also start with /**. This patch prevents gtkdoc-mkdb from complaining. https://bugzilla.gnome.org/show_bug.cgi?id=688418
* girepository: Add g_interface_info_find_signalTorsten Schönfeld2012-08-251-0/+1
| | | | | | | Add the convenience method g_interface_info_find_signal, mirroring g_object_info_find_signal. https://bugzilla.gnome.org/show_bug.cgi?id=682672
* Docs: fix typoClaudio Saavedra2011-12-191-1/+1
|
* Allow enums and bitfields to have static methodsTorsten Schönfeld2011-08-161-0/+2
| | | | | | | | | | | | | This uses the same backcompat machinery that was introduced for static methods for non-class types, so this change does not break users of the existing presentations. New libgirepository API: g_enum_info_get_n_methods g_enum_info_get_method https://bugzilla.gnome.org/show_bug.cgi?id=656499
* build: Fix gtk-doc srcdir != builddirColin Walters2011-07-271-1/+1
| | | | | gtk-doc apparently lies about the path being relative...fix it by just using $(srcdir).
* gtk-doc: Update for renamed libgirepository-internals.laColin Walters2010-11-171-1/+1
|
* Switch to nonrecursive make for core (i.e. not tests/)Colin Walters2010-11-091-1/+1
| | | | | This is cleaner and faster, and prepares us better for an incoming import of CMPH.
* docs: Don't conditionalize on ENABLE_GTK_DOCColin Walters2010-10-061-2/+0
| | | | | | | | | OS vendors which compile from the part-binary "tarballs" which include e.g. pregenerated gtk-doc, they typically don't pass --enable-gtk-doc. So conditionalizing "make install" for docs on ENABLE_GTK_DOC won't work. This is the same as GTK+ and other projects currently work.
* [GIRepository] Rename GTypelib to GITypelibJohan Dahlin2010-08-311-1/+1
| | | | | Keep a typedef for backwards compatibility, until the major bindings has moved over.
* Add new API g_typelib_require_private()Steve Frécinaux2010-08-031-0/+1
| | | | | | | This is equivalent to g_typelib_require() but intended for use with private typelibs, which get loaded from the provided directory. https://bugzilla.gnome.org/show_bug.cgi?id=625672
* [girepository] Update documentationJohan Dahlin2010-07-281-0/+1
|
* [GIRepository] Rename g_irepository_enumerateJohan Dahlin2010-07-281-0/+1
| | | | Rename it to g_irepository_enumerate_versions
* Add support for non-GObject fundamental objectsJohan Dahlin2010-07-091-0/+13
| | | | | | | | | | | | | | This patch adds support for instantiable fundamental object types, which are not GObject based. This is mostly interesting for being able to support GstMiniObject's which are extensivly used in GStreamer. Includes a big test case to the Everything module (inspired by GstMiniObject) which should be used by language bindings who wishes to test this functionallity. This patch increases the size of the typelib and breaks compatibility with older typelibs. https://bugzilla.gnome.org/show_bug.cgi?id=568913
* Allow attributes on parameters and return valuesDavid Zeuthen2010-06-241-0/+2
| | | | | | | | | | | | | | | | | | Any annotation where the key has a dot in the name will go into the attribute list. For example * @arg: (foo.bar baz): some arg the parameter @arg will get the attribute with key foo.bar and value baz. This also works for. * Returns: (foo.bar2 baz2): the return value Also add tests for this new feature. See https://bugzilla.gnome.org/show_bug.cgi?id=571548 Signed-off-by: David Zeuthen <davidz@redhat.com>
* [docs] Add missing symbolsJohan Dahlin2010-06-111-2/+20
|
* Support the (transfer) annotation for properties.Tomeu Vizoso2010-06-081-0/+1
| | | | | | | | | | | | * girepository/*: Add g_property_info_get_ownership_transfer() and write the transfer attribute of properties into the typelib. * giscanner/*: Parse the (transfer) annotation and write it into the .gir. * tools/generate.c: Read the transfer annotation for properties and write to the .tgir. https://bugzilla.gnome.org/show_bug.cgi?id=620484
* [docs] Fix a typo in the overviewJohan Dahlin2010-05-312-41/+131
| | | | Regenerate PNG
* [docs] Add an overview pageJohan Dahlin2010-05-305-1/+467
| | | | | Add an overview page for the documentation with a simple diagram explaining the relationship between the main components.
* [docs] Link to top of pagesJohan Dahlin2010-05-281-17/+17
|
* [docs] SignalInfo is a sub-struct of CallableInfoJohan Dahlin2010-05-271-1/+1
|
* Remove g_arg_info_is_dipper from documentationJohan Dahlin2010-05-271-1/+0
|
* [docs] Add a struct hierarchy pageJohan Dahlin2010-05-252-0/+45
|
* [docs] Reorganize sectionsJohan Dahlin2010-05-191-25/+27
| | | | | | Mark macros as standard and a couple of structs as private. Remove multiple defintion of GITypelib to reduce gtk-doc spew.
View Lorry Controller Status