summaryrefslogtreecommitdiff
path: root/docs/website
Commit message (Collapse)AuthorAgeFilesLines
* docs: Add Emmanuele's suggestions to "Writing Bindable APIs"Emmanuele Bassi2023-03-181-5/+11
| | | These suggestions came up in code review.
* docs: Advice on transfer-none return valuesPhilip Chimento2023-03-181-0/+26
| | | | | | | APIs such as the Gio.AppInfo.get_id vfunc which contravene this advice, can cause memory leaks. (See https://gitlab.gnome.org/GNOME/gjs/-/issues/519) Document it here so that it hopefully happens less often in the future.
* docs: Incorporate Emmanuele's bindable API advicePhilip Chimento2023-03-181-2/+58
| | | | | | This includes the new points from Emmanuele's recent blog post https://www.bassi.io/articles/2023/02/20/bindable-api-2023/ into the "Writing Bindable APIs" doc.
* Reword closure annotation documentationbadcel2023-02-131-8/+6
|
* docs: Be more specific on error out casesCorentin Noël2023-02-131-1/+3
| | | | | Add a disambiguation of what to return and do with the out values in case an error is thrown.
* Document the newly added attributesEmmanuele Bassi2023-01-081-0/+8
| | | | | Add the (copy-func) and (free-func) annotations to the documentation, and the copy-function and free-function attributes to the GIR schema.
* Add `default-value` annotationEmmanuele Bassi2023-01-081-0/+4
| | | | | | | An escape hatch to specify a freeform string for the default value of a property. Fixes: #4
* Document the newly added g-ir-scanner CLI optionEmmanuele Bassi2022-02-121-0/+6
|
* scanner: Add (emitter) annotation for signalsEmmanuele Bassi2022-02-121-0/+4
| | | | | | Signals that have an emitter function should have an annotation to allow consumers of the introspection XML to effectively pair signals to their corresponding emitter functions that share the same prototype.
* scanner: Add strict modeEmmanuele Bassi2022-02-121-0/+4
| | | | | | | | | To avoid introducing additional strictness onto unsuspecting libraries, we introduce a new mode: "strict". The strict mode is opt-in, and used to signal potential issues with the public API once exposed by language bindings, even when it's fully introspectable.
* Add "forever" scope to docsbadcel2022-01-211-0/+1
|
* Update giannotations.rst Emmanuele Bassi2021-12-071-9/+9
| | | | | | Don't use a real function to describe optional/nullable differences, to avoid getting into the weeds when it comes to edge cases. Fixes: #211
* Update build_test.rst Emmanuele Bassi2021-12-071-21/+5
| | | | | Remove mentions of Autotools: we only support Meson. Fixes: #327
* docs: Point to the GObject reference on docs.gtk.orgEmmanuele Bassi2021-11-072-5/+3
| | | | Do not use the snapshot of the old developer.gnome.org website.
* docs: Point to the GitLab page for libgrepository's API referenceEmmanuele Bassi2021-11-071-1/+1
| | | | | Do not use the snapshot of the old developer.gnome.org website; we generate and publish the API reference ourselves.
* docs: Clarify scope of property-related annotationsEmmanuele Bassi2021-08-051-4/+4
| | | | | | | | The `set-property` and `get-property` identifier annotations only apply to methods. The `setter` and `getter` identifier annotations only apply to properties.
* 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-051-0/+8
|
* docs: Add the new accessors annotationsEmmanuele Bassi2021-08-051-0/+8
| | | | | Mention them in the annotations list, and add the new attributes to the GIR schema.
* Update the developer.gnome.org URLsEmmanuele Bassi2021-08-053-4/+4
| | | | | | | 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-093-2/+71
|
* Add Crystal lnaguage bindings to Users listCristian Molina2021-05-051-0/+1
|
* docs: Remove mention of mailing listsebassi/for-masterEmmanuele Bassi2021-03-171-1/+1
| | | | We don't use them any more; discussions happen on Discourse.
* 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: Update website linkJan Tojnar2020-05-154-4/+4
|
* 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: include '--c-include' in g-ir-scanner man page. Fixes #275Christoph Reiter2019-03-241-0/+4
|
* website: Add link to C/typelib ABI cross-validatorTomasz Miąsko2019-02-131-0/+1
|
* website: add cppgir C++ bindingMark Nauwelaerts2019-01-051-0/+1
|
* Add a --version option to g-ir-compiler and g-ir-generate. Fixes #55Christoph Reiter2018-12-192-0/+6
|
* 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
* 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.
* Sphinx based user documentationChristoph Reiter2018-06-1625-0/+2721
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
View Lorry Controller Status