summaryrefslogtreecommitdiff
path: root/docs/gir-1.2.rnc
Commit message (Collapse)AuthorAgeFilesLines
* Allow to specify the format of the documentationtintou/doc-formatCorentin Noël2023-04-291-1/+11
| | | | | Helps the consumers of the documentation to assume that the documentation is using gtk-doc format or gi-docgen.
* docs: Fix `deprecated` typeNahu2023-03-041-1/+1
|
* Split disguised attribute into twoEmmanuele Bassi2023-01-081-2/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The disguised attribute started off as a way to indicate a typedef to a structure pointer, e.g. typedef struct Foo* FooPtr; Over the years, though, it started to include opaque structure types, e.g. typedef struct _FooObject FooObject; typedef struct _FooObjectClass FooObjectClass; This has led to issues in language bindings, code generators, and documentation generators, which now have issues when dealing with both pointer aliases and opaque types. An initial attempt at fixing this mess in commit f606183a ended up breaking Vala, and had to be reverted. To avoid breaking existing users we can follow a similar approach to the allow-none/nullable/optional solution: 1. introduce a new pair of attributes: "pointer" and "opaque" 2. deprecate the "disguised" attribute The "pointer" attribute covers the case of pointer types. The "opaque" attribute covers the case of opaque structured types. See also: https://gitlab.gnome.org/GNOME/vala/-/issues/735 Fixes: #101
* 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 an optional attribute for the property default valueEmmanuele Bassi2023-01-081-0/+2
| | | | | | | | | The default-value attribute for a property element is fundamentally meant for documentation generators. We only care about the GIR data, as the conversion from the default value to a string is lossy by definition, and may very well not roundtrip.
* Fix typo in async scope descriptionbadcel2022-10-061-2/+2
|
* docs: Update documentation links in the GIR schemaTestingPlant2022-04-291-2/+2
|
* scanner: Add (emitter) annotation for signalsEmmanuele Bassi2022-02-121-0/+2
| | | | | | 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.
* Record: Properties are not supportedbadcel2022-02-101-2/+1
|
* Fix typos in commentsbadcel2022-02-091-4/+4
|
* Add forever scopeMarcel Tiede2022-01-161-4/+4
|
* docs: Fix documentation links in the GIR schemaEmmanuele Bassi2021-11-071-6/+6
|
* docs: Fix the "final" attribute in the GIR schemaEmmanuele Bassi2021-08-051-1/+1
| | | | | | The "final" attribute is not namespaced. Like "abstract", the "final" flag is shared across type systems, it's not strongly related to GObject types.
* Document the new property accessors annotationsEmmanuele Bassi2021-08-051-0/+4
|
* docs: Add the new accessors annotationsEmmanuele Bassi2021-08-051-0/+5
| | | | | Mention them in the annotations list, and add the new attributes to the GIR schema.
* 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-051-6/+6
| | | | | | | 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.
* 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>
* Fix syntax errors in gir-1.2.rncPhil Clayton2021-03-141-11/+11
| | | | Closes #373
* 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
|
* 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
* 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
* docs: Add RelaxNG schema for GIR's XML formatEmmanuele Bassi2016-05-111-0/+231
This is an attempt at standardising the GIR XML in a way that we can reliably validate; the schema is enough to validate simple GIR files, but it still needs work for complex ones, like GTK's. I've decided to use the compact Relax NG syntax as the schema format because it's definitely easier to read and write that the DTD format. Since the current XML version is 1.2, let's standardise on that instead of making up a version 1.0.