summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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...
* Add giscanner package documentationDieter Verfaillie2013-10-088-0/+686
| | | | | | | | | | Using Sphinx [1] markup for now. We eventually might want to add GTK-Doc support for python and dogfood g-ir-doctool on this package. [1] De facto standard Python documentaton tool: http://sphinx-doc.org https://bugzilla.gnome.org/show_bug.cgi?id=688897
* docs: Update Makefile.amDieter Verfaillie2013-10-081-1/+1
|
* g-ir-compiler: remove references to --code, remove --no-init optionsDieter Verfaillie2013-10-081-10/+1
| | | | | | | | | The "--code" option was removed years ago in ac81f3e8c5f1c380d16677232d67466e739da283 so remove references to it from README and g-ir-compiler(1) Remove the "--no-init" option from g-ir-compiler and g-ir-compiler(1) as it was documented to "can only be used if --code is also specified", so no reason to keep it around.
* g-ir-scanner.1: Fix doc for --programSimon Kågedal Reimer2013-06-101-1/+1
| | | | | | Binary takes --introspect-dump argument, not --introspect. https://bugzilla.gnome.org/show_bug.cgi?id=701958
* 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
* g-ir-scanner.1: English fixColin Walters2012-10-271-1/+1
|
* docs: Show correct path used by g-ir-scannerPierre-Louis Bonicoli2012-10-271-1/+1
| | | | | | Signed-off-by: Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=668193
* Make gtk-doc not a hard dependency of gobject-introspectionJavier Jardón2012-09-271-0/+2
| | | | Fixes https://bugzilla.gnome.org/show_bug.cgi?id=684795
* 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).
* Add GI_SCANNER_DISABLE_CACHE environment variableColin Walters2011-05-021-0/+3
| | | | https://bugzilla.gnome.org/show_bug.cgi?id=649054
* 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.
* Do not use triple dashesJohan Dahlin2010-09-251-3/+3
|
* NEWS->git shortlogJohan Dahlin2010-09-151-1/+0
|
* scanner: Add --include-uninstalledColin Walters2010-09-021-4/+8
| | | | | | | | We need a way to add a .gir file, without also attempting to load the pkg-config file for it (since it may not be installed yet). Example: clutter builds multiple .gir files, Cally-1.0 depends on Clutter-1.0.
* scanner: Add --accept-unprefixedColin Walters2010-09-011-0/+4
| | | | This is necessary for Mutter right now.
* [GIRepository] Rename GTypelib to GITypelibJohan Dahlin2010-08-311-1/+1
| | | | | Keep a typedef for backwards compatibility, until the major bindings has moved over.
* Major rewriteColin Walters2010-08-311-39/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | One of the first big changes in this rewrite is changing the Type object to have separate target_fundamental and target_giname properties, rather than just being strings. Previously in the scanner, it was awful because we used heuristics around strings. The ast.py is refactored so that not everything is a Node - that was a rather useless abstraction. Now, only things which can have a GIName are Node. E.g. Type and Field are no longer Node. More things were merged from glibast.py into ast.py, since it isn't a very useful split. transformer.py gains more intelligence and will e.g. turn GLib.List into a List() object earlier. The namespace processing is a lot cleaner now; since we parse the included .girs, we know the C prefix for each namespace, and have functions to parse both C type names (GtkFooBar) and symbols gtk_foo_bar into their symbols cleanly. Type resolution is much, much saner because we know Type(target_giname=Gtk.Foo) maps to the namespace Gtk. glibtransformer.py now just handles the XML processing from the dump, and a few miscellaneous things. The major heavy lifting now lives in primarytransformer.py, which is a combination of most of annotationparser.py and half of glibtransformer.py. annotationparser.py now literally just parses annotations; it's no longer in the business of e.g. guessing transfer too. finaltransformer.py is a new file which does post-analysis for "introspectability" mainly. girparser.c is fixed for some introspectable=0 processing.
* Makefile.introspection: Add _EXPORT_PACKAGES variable.Luca Bruno2010-08-281-3/+9
| | | | This new variable maps to --pkg-export.
* Remove --noclosure argumentColin Walters2010-08-171-3/+0
| | | | It's obsoleted by the introspectable=0 handling.
* [man] Mention XDG_DATA_DIRSJohan Dahlin2010-08-131-1/+4
|
* 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
* Don't conditionalize reference/ build on gtk-doc being enabledColin Walters2010-07-121-4/+1
| | | | gtk-doc already does that for us
* 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
* In verbose mode, print out the dump compilationColin Walters2010-07-071-0/+3
| | | | | | | | | | | | When debugging the dumper, it's extremely useful to be able to see the argument it's passing to the compiler/linker. This patch makes g-ir-scanner work the same way as libtool basically; we default to printing out stuff, and add a --quiet option. The Makefile.introspection handles passing --quiet automatically. https://bugzilla.gnome.org/show_bug.cgi?id=622751
* 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>
* Support introspectable=no attribute, add warnings frameworkColin Walters2010-06-171-0/+6
| | | | | | | | | | | | | | | | | | This work allows us to move closer to replacing gtk-doc, among other things. We add a generic attribute "introspectable", and inside the typelib compiler if we see "introspectable=no", we don't put it in the typelib. This replaces the hackish pre-filter for varargs with a much more generic mechanism. The varargs is now handled in the scanner, and we emit introspectable=no for them. Add generic metadata to Node with references to file/line/column, which currently comes from symbols. Add scanner options --warn-all and --warn-error. https://bugzilla.gnome.org/show_bug.cgi?id=621570
* [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.
* [docs] Remove multiple GIFunctionInfo linkJohan Dahlin2010-05-191-1/+0
|
* [docs] Remove title from gi-sections.txtJohan Dahlin2010-05-191-19/+0
| | | | They will be defined in inline gtk-doc comments.
* [docs] Reorganize structs into chaptersJohan Dahlin2010-05-182-123/+237
| | | | | | Instead of displaying all structures and methods in girepository.h on one page, split them out to a bunch of pages.
* [girepository] Document most of the structsJohan Dahlin2010-05-181-1/+2
|
View Lorry Controller Status