summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Clarify the meaning of accessor functionsEmmanuele Bassi2021-08-051-4/+16
| | | | | Public accessor functions are the functions typically called through g_object_set_property() and g_object_get_property().
* Document the new property accessors annotationsEmmanuele Bassi2021-08-052-0/+12
|
* 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.
* docs: Add the new accessors annotationsEmmanuele Bassi2021-08-052-0/+13
| | | | | Mention them in the annotations list, and add the new attributes to the GIR schema.
* Add newly added girepository symbol to the API referenceEmmanuele Bassi2021-08-051-0/+1
|
* Add "final" class attributeEmmanuele Bassi2021-08-051-0/+2
| | | | | | | | A "final" class is a leaf node in a derivable type hierarchy, and cannot be derived any further. This matches the changes in libgobject that introduced G_TYPE_FLAG_FINAL to the type flags.
* Update the developer.gnome.org URLsEmmanuele Bassi2021-08-055-11/+11
| | | | | | | 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: Add g-ir-doc-tool man pageDavid King2021-07-095-3/+146
|
* Add glib:name to enum memberMarc-André Lureau2021-06-201-1/+3
| | | | | | | This member will contain the string from the GEnumValue/GFlagsValue 'value_name' introspection dump. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
* Add Crystal lnaguage bindings to Users listCristian Molina2021-05-051-0/+1
|
* Merge branch 'ebassi/for-master' into 'master'Emmanuele Bassi2021-03-181-1/+1
|\ | | | | | | | | docs: Remove mention of mailing lists See merge request GNOME/gobject-introspection!261
| * docs: Remove mention of mailing listsebassi/for-masterEmmanuele Bassi2021-03-171-1/+1
| | | | | | | | We don't use them any more; discussions happen on Discourse.
* | Fix syntax errors in gir-1.2.rncPhil Clayton2021-03-141-11/+11
|/ | | | Closes #373
* website: Add section about property/method name conflictsPhilip Chimento2020-08-021-0/+9
| | | | | This is a trap that C APIs can fall into, so it should be mentioned on the "Writing Bindable APIs" page.
* 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.
* docs: Update website linkJan Tojnar2020-05-157-7/+7
|
* examples: Make self contained and add build system integration examplesChristoph Reiter2019-11-091-1/+1
| | | | | | | | | | The libgirepository example now is its own meson project. There now is a small library that is buildable with meson and autotools which creates a gir/typelib. Usefull for testing our build system integration and for small experiments. Fixes #287
* Add Ruby-GNOME to Users.rstkojix22019-09-261-0/+1
|
* Fix broken linkkojix22019-09-261-1/+1
|
* docs: Document GI_CROSS_LAUNCHER envvarEmmanuele Bassi2019-09-041-0/+4
| | | | | The g-ir-scanner man page should include a mention of the GI_CROSS_LAUNCHER environment variable.
* updated thanks to comments from reviewersDavid Bellot2019-04-021-10/+11
|
* docs: finally transformed tabs to spaces in GIR xml relaxng fileDavid Bellot2019-04-021-164/+164
|
* docs: added missing docs for annotations attributeDavid Bellot2019-04-021-0/+3
|
* docs: added complete documentation as comments in the RelaxNG schemaDavid Bellot2019-04-021-21/+217
|
* docs: include '--c-include' in g-ir-scanner man page. Fixes #275Christoph Reiter2019-03-242-0/+8
|
* Drop autotools build systemChristoph Reiter2019-03-112-125/+0
|
* website: Add link to C/typelib ABI cross-validatorTomasz Miąsko2019-02-131-0/+1
|
* 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.
* meson: use underscore as a separator in build optionsChristoph Reiter2019-01-071-1/+1
| | | | This is what https://wiki.gnome.org/Initiatives/GnomeGoals/MesonPorting suggests.
* website: add cppgir C++ bindingMark Nauwelaerts2019-01-051-0/+1
|
* 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.
* Add a --version option to g-ir-compiler and g-ir-generate. Fixes #55Christoph Reiter2018-12-194-0/+12
|
* 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.
* Merge branch 'girepo-docs-cleanup' into 'master'Christoph Reiter2018-12-1410-900/+25
|\ | | | | | | | | | | | | docs: Remove everything not related to libgirepository and restructure. Fixes #244 Closes #244 See merge request GNOME/gobject-introspection!96
| * 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.
* | website: add a page with build/test instructionsChristoph Reiter2018-12-142-0/+69
|/ | | | | | My goal here is to keep it simple and get people started quickly. See !96
* 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().
* NEWS: fix version numbersChristoph Reiter2018-12-091-1/+1
| | | | glib versions leaked
* NEWS: convert to reST and include it in the docsChristoph Reiter2018-12-095-2/+18
| | | | | So it's visible on the main website and has nice links to the issues and merge requests.
* writer: Include documentation and symbol position in source filesThibault Saunier2018-11-281-0/+8
| | | | | | | | | | | Some documentation tool (as hotdoc[0]) need to have information about symbol declaration and documentation positions in the source files to be able to do smart indexing (automatically build the documenation index). [0] https://hotdoc.github.io/ Fixes #175
* Merge branch 'autotools-dist-meson' into 'master'Christoph Reiter2018-06-232-1/+6
|\ | | | | | | | | autotools: dist all meson files See merge request GNOME/gobject-introspection!44
| * autotools: dist all meson filesChristoph Reiter2018-06-212-1/+6
| |
* | Remove giscanner sphinx docsChristoph Reiter2018-06-218-686/+0
|/ | | | | It's unused and just exposes the Python docstrings through autodoc and doesn't contain any extra documentation itself.
* Sphinx based user documentationChristoph Reiter2018-06-1628-151/+2965
| | | | | | | | | | | | | | | | | | | | | | The current output (more or less a straight copy of the wiki) is available here: https://gi.readthedocs.io This contains two changes: * Converts all (not completely outdated) wiki pages to a sphinx based documentation. * Converts the man pages to reST and adds a Makefile for building them using rst2man. So they can be easily exposed in the sphinx docs. Goals: * Have a user focused/compact documentation instead of random wiki pages with various todo/ideas pages. * Take advantage of the gitlab MR workflow by * allowing large documentation changes/refactorings with reviews * allowing to combine features changes with documentation changes in MRs
* Update bug reporting links.Tomasz Miąsko2018-03-103-3/+6
| | | | | | Also disable automatic hyphenation in manual pages to prevent wrapping long URLs. Ensures that URLs can be easily navigated by clicking on them.
* Build docsPatrick Griffis2018-03-102-0/+45
|
* Initial work on meson portPatrick Griffis2018-03-101-0/+2
|
* removing $(srcdir) because it is not replaced correctly and not necessaryKarl-Philipp Richter2018-02-081-1/+1
| | | | See #120.
* Document the newly added GI_HOST_OS envvarEmmanuele Bassi2018-01-251-0/+4
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=761985
View Lorry Controller Status