summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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
* docs: Remove incorrect name ruleEmmanuele Bassi2018-01-251-2/+1
| | | | | | | The leading `lib` should be passed as part of the shared library name in the `--shared-library` argument for g-ir-compiler. https://bugzilla.gnome.org/show_bug.cgi?id=699354
* 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.
* build: Install the gir-1.2 schema system-widePhilip Withnall2017-05-041-0/+4
| | | | | | | | Install the schema to $(datadir)/glib-2.0/schemas, so that projects which depend on GLib can validate their GIR files at build or distribution time. https://bugzilla.gnome.org/show_bug.cgi?id=774019
* 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
* g-ir-scanner: document GI_SCANNER_DEBUG in man pageSebastian Geiger2017-02-141-0/+4
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=778509
* Fix "Annotation" element in RelaxNG schemaRico Tzschichholz2016-11-041-2/+2
|
* Update RelaxNG schema to validate all common girsChristoph Reiter2016-05-121-131/+379
| | | | | | | | | | | This updates the schema to validate all GIRs currently available in Debian unstable except a few obviously broken ones. For testing the following tools were used: $ trang gir-1.2.rnc gir-1.2.rng $ xmllint --noout --relaxng gir-1.2.rng Gtk-3.0.gir https://bugzilla.gnome.org/show_bug.cgi?id=766313