Commit Graph

436 Commits

Author SHA1 Message Date
Christian Dywan
53f398f52a Mention g_object_run_dispose correctly in tutorial
Fixes: https://bugzilla.gnome.org/show_bug.cgi?id=630797
2010-10-08 15:25:31 +02:00
Stefan Kost
919f64acab build: fix out of srcdir build
The gtk-doc makefile rules do cd srcdir && cp $(HTML_IMAGES) target/ and this
breaks for "srcdir" != ".".
2010-09-23 23:38:05 +03:00
Stefan Kost
de432280a0 docs: shorten var name in example
We use 'pspec' instead of 'maman_param_spec' elsewhere too.
2010-09-19 22:06:10 +03:00
Stefan Kost
aa8c8df44f docs: fix iface type naming 2010-09-19 22:03:40 +03:00
Stefan Kost
58e5b01fbc docs: fix docbook validity
'type' must be inside of 'link'.
2010-09-19 21:50:31 +03:00
Stefan Kost
409f7db894 docs: cleanup constructor example
Remove unused var and chain-up the sane way we do elsewhere.
2010-09-19 21:37:19 +03:00
Stefan Kost
a6ad0fbec2 docs: use passive voice. 2010-09-19 21:33:52 +03:00
Emmanuele Bassi
9cd43d7a4c gobject: Add install_properties()
Since we added g_object_notify_by_pspec(), an efficient way to install
and notify properties relies on storing the GParamSpec pointers inside
a static arrays, like we do for signal identifiers.

Instead of multiple calls to g_object_class_install_property(), we
should have a single function to take the static array of GParamSpecs
and iterate it.

https://bugzilla.gnome.org/show_bug.cgi?id=626919

Signed-off-by: Emmanuele Bassi <ebassi@linux.intel.com>
2010-09-13 12:34:53 +01:00
Emmanuele Bassi
d31c1c863a docs: Fix up GDateTime for the GObject reference 2010-08-25 16:24:46 +01:00
Christian Persch
dc1999316d Add G_DEFINE_{BOXED,POINTER}_TYPE[_WITH_CODE]
Add convenience type definition macros for boxed and pointer types
similar to G_DEFINE_TYPE for object types. Bug #449565.
2010-08-18 00:12:22 +02:00
Ryan Lortie
b3b7ea8e22 Replace -I with $(glib_INCLUDES) and friends
Stop using ad hoc -I in all of our Makefile.am.  Use the new variables
instead.
2010-08-06 13:10:34 -04:00
Emmanuele Bassi
3be3ad61d1 binding: Add a closure-based variant of bind_property_full()
Since using the function pointer version muddles the memory management
requirements of language bindings, we should implement a GClosure-based
variant on top of g_object_bind_property_full().

https://bugzilla.gnome.org/show_bug.cgi?id=622278
2010-08-03 09:51:49 +01:00
Stefan Kost
463edcb045 docs: xi:include the annotation glossary to kill warnings and make them work 2010-07-14 11:57:36 +03:00
Ryan Lortie
adde752ec5 More docs fixes
Remove the g*alias.h from the ignore lists

  Remove other old files from ignore lists

  Clean up gobject docs
2010-07-12 17:46:17 -04:00
Matthias Clasen
3549e06f81 Ignore gatomicarray.h
Otherwise gtk-doc picks up declarations from that header and is
disappointed when they are not documented.
2010-06-23 09:25:30 -04:00
Matthias Clasen
9c6130cdde silence gtk-doc
Add g_error_get_type to a private section in gobject-sections.txt
so gtk-doc doesn't complain about it.
2010-06-23 09:25:29 -04:00
Matthias Clasen
7d81e99c4b Add an index for 2.26 api additions 2010-06-23 09:25:29 -04:00
Ryan Lortie
a4cd39e741 gobject docs: ignore some sgml files 2010-06-21 14:01:50 -04:00
Christian Persch
db68f8203a Add g_value_take_variant
Turns out we do need g_value_take_variant(), so we can correctly
implement VARIANT:* marshalers.

Bug #621947.
2010-06-19 19:07:36 +02:00
Christian Persch
30df71e382 Add VARIANT to glib-genmarshal docs 2010-06-18 00:10:54 +02:00
Christian Persch
4708b8ecc3 Add fundamental type and pspec for GVariant
Make G_TYPE_VARIANT a fundamental type instead of boxed, and add
g_variant_{set,get,dup}_variant.

Add GParamSpecVariant.

Bug #610863.
2010-06-17 21:00:54 +02:00
Emmanuele Bassi
6d1d9cf1b5 gobject: Add GBinding
GBinding is a simple, opaque object that represents a binding between a
property on a GObject instance (source) and property on another GObject
instance (target).

https://bugzilla.gnome.org/show_bug.cgi?id=348080
2010-06-15 16:06:18 +01:00
Damien Lespiau
f3879a4bdc Introduce g_object_notify_by_pspec()
g_object_notify_by_pspec() will emit the "notify" signal on the given
pspec, short-circuiting the hash table lookup needed by
g_object_notify(). The suggested and documented way of using
g_object_notify_by_pspec() is similar to the way of emitting signals
with their ID.

Emission tests (with no handler attached to the notify signal) show a
10-15% speedup over using g_object_notify().

https://bugzilla.gnome.org/show_bug.cgi?id=615425
2010-06-15 10:51:36 +01:00
Ryan Lortie
47e07f9f78 another occurrence of the last fix (@XSLTPROC@) 2010-05-24 22:37:43 -04:00
Matthias Clasen
8db946fdfb Clean up man page handling
Remove all formatted man pages from git, and use the same
Makefile fragment in all doc dirs.
2010-05-21 22:28:42 -04:00
Javier Jardón
3b8d0a4ac2 Add G_TYPE_CLASS_GET_PRIVATE macro to docs 2010-05-20 01:59:17 +02:00
Matthias Clasen
6223341cac Merge branch 'gdbus-merge'
Conflicts:
	docs/reference/gio/gio-docs.xml
	docs/reference/gio/gio-sections.txt
	gio/tests/Makefile.am
2010-05-13 23:08:34 -04:00
Ryan Lortie
62c0454b34 documentation for glib-mkenums @valuenum@ 2010-05-14 01:55:46 +02:00
David Zeuthen
3baff96b37 Make sure G_TYPE_ERROR shows up in the docs
This is related to bug 614541.

Signed-off-by: David Zeuthen <davidz@redhat.com>
2010-04-23 12:14:37 -04:00
Javier Jardón
bed462046a [docs] Fix G_VALUE_COLLECT_INIT documentation
Add the documentation to the corresponding section

This macro was introduced in
commit 546fc0ca33
2010-04-20 02:12:02 +02:00
Matthias Clasen
cd9b8b563f 2.25.0 2010-04-19 17:30:42 -04:00
David King
9023ac0934 [docs] Remove unused sgml template from GObject documentation
https://bugzilla.gnome.org/show_bug.cgi?id=589351

Signed-off-by: Javier Jardón <jjardon@gnome.org>
2010-04-18 20:21:10 +02:00
Matthias Clasen
61a5692fa1 Man page tweaks
Add enough info to keep the docbook stylesheets from embedding
FIXMEs in the formatted output.
2010-04-16 20:43:53 -04:00
Javier Jardón
c3f1025c33 Remove g_type_class_get_private() public documentation
This is a internal function needed for the documented
G_TYPE_CLASS_GET_PRIVATE() macro

This was introduced by error in
commit 81e2aa941b
2010-03-29 18:23:48 +02:00
Matthias Clasen
81e2aa941b Some more doc cleanups 2010-03-26 10:11:46 -04:00
Christian Dywan
35059f2c04 Correct typo of libray/ library in GObject tutorial
Fixes bug #613667
2010-03-23 11:59:43 +01:00
Ryan Lortie
6f33038397 gtk-doc fixups 2010-03-21 14:12:48 -05:00
Stefan Kost
fa32ee5610 docs: exchange "Subversion" with "source code repository"
Fixes the outdated reference.
2010-03-06 13:36:38 +02:00
Matthias Clasen
03fc92784d Add indices for 2.24 additions 2010-02-21 19:48:22 -05:00
Matthias Clasen
80a160c7c6 Small doc fixes 2010-02-21 19:46:57 -05:00
Matthias Clasen
de6914a46a Add a pointer to G_DEFINE_INTERFACE 2010-02-21 15:32:08 -05:00
Ryan Lortie
1e655eb02c merge GVariant 2010-02-10 11:35:01 -05:00
Stefan Kost
7211f7f8eb docs: switch to xi:inbclude for the content to save some more seconds 2010-01-07 11:34:01 +02:00
Stefan Kost
d01e2527ce docs: use xi:include to use the generated indexes if available.
This works transparantly for people with new enough gtk-doc (>=1.11) and
significantly improves the build time.
2010-01-07 11:34:00 +02:00
Dan Winship
91d96350a7 Add G_DEFINE_INTERFACE
This is a macro similar to G_DEFINE_TYPE but it lets you define
interfaces rather than classes.

For discussion, see bug #320482
2009-12-01 10:44:42 +01:00
Alexander Larsson
7d51c96e5e Add G_IMPLEMENT_INTERFACE_DYNAMIC
Convenience macro to easy interface addition for dynamic types.

https://bugzilla.gnome.org/show_bug.cgi?id=508157
2009-11-26 11:20:18 +01:00
Matthias Clasen
400959ddbd 2.21.3 2009-07-06 00:31:47 -04:00
Christian Persch
18e0bcf02f Add @basename@ substitution to glib-mkenums
Move man page addition to the right place. Bug #587307.
2009-07-03 21:20:11 +02:00
Matthias Clasen
a28215fa90 Release 2.21.0 2009-05-03 18:08:49 -04:00
Matthias Clasen
008ae16d75 Add new functions 2009-05-03 17:00:37 -04:00
Matthias Clasen
5a8a224ff0 2.20.0
svn path=/trunk/; revision=7976
2009-03-13 05:44:11 +00:00
Matthias Clasen
3f07ef2119 2.19.9
svn path=/trunk/; revision=7939
2009-03-02 05:49:44 +00:00
Matthias Clasen
64bc5d874f Fix some typos
svn path=/trunk/; revision=7927
2009-03-01 06:59:31 +00:00
Stefan Kost
c34b273958 Add online urls for library.gnome.org. This allows other docs to do
* gio/gio-docs.xml:
	* glib/glib-docs.sgml:
	* gobject/gobject-docs.sgml:
	  Add online urls for library.gnome.org. This allows other docs to do
          gtkdoc-rebase --online --html-dir=html
          before publishing docs and have working xrefs.


svn path=/trunk/; revision=7853
2009-02-06 08:09:24 +00:00
Matthias Clasen
1643b117b9 Fix an example.
svn path=/trunk/; revision=7757
2009-01-02 02:26:39 +00:00
Matthias Clasen
7570db065a Remove the questionable closing sentence and all references to private
* gobject/tut_gtype.xml: Remove the questionable closing sentence
        and all references to private functions. Pointed out by Christian
        Dywan.


svn path=/trunk/; revision=7711
2008-12-01 03:13:46 +00:00
Matthias Clasen
db830dd381 Fix some documentation typos
svn path=/trunk/; revision=7707
2008-11-28 23:53:13 +00:00
Matthias Clasen
08cae5cd63 Nicer indices
svn path=/trunk/; revision=7665
2008-11-21 07:28:50 +00:00
Behdad Esfahbod
d442b59022 Bug 559448 – GObject Reference Manual (typo)
2008-11-10  Behdad Esfahbod  <behdad@gnome.org>

        Bug 559448 – GObject Reference Manual (typo)

        * gobject/tut_gobject.xml: Fix typo. 


svn path=/trunk/; revision=7646
2008-11-10 14:37:21 +00:00
Matthias Clasen
82c68c6a14 2.19.0
svn path=/trunk/; revision=7611
2008-10-16 23:59:50 +00:00
Ryan Lortie
920f3bffb3 Bug 549771 – improved .gitignore for glib
2007-09-02  Ryan Lortie  <desrt@desrt.ca>

        Bug 549771 – improved .gitignore for glib

        * docs/reference/.gitignore:
        * docs/reference/gio/.gitignore:
        * docs/reference/gobject/tmpl/.gitignore:
        * gio/.gitignore:
        * gio/tests/.gitignore:
        * glib/.gitignore:
        * glib/libcharset/.gitignore:
        * glib/tests/.gitignore:
        * gmodule/.gitignore:
        * gobject/.gitignore:
        * gobject/tests/.gitignore:
        * po/.gitignore:
        * tests/.gitignore: new files
        * .gitignore: remove 'build' (since it's part of glib now), add more
        useful things.


svn path=/trunk/; revision=7432
2008-09-02 18:40:39 +00:00
Matthias Clasen
7a9c75a099 Add g_object_get_type
svn path=/trunk/; revision=7429
2008-09-02 17:39:32 +00:00
Matthias Clasen
cc9841557d Add a 2.18 index
svn path=/trunk/; revision=7296
2008-08-04 16:38:36 +00:00
Matthias Clasen
cb3b591aaa Add new api
svn path=/trunk/; revision=7207
2008-07-19 02:15:31 +00:00
Matthias Clasen
adae2cf59b Updates
svn path=/trunk/; revision=7201
2008-07-18 17:55:13 +00:00
Matthias Clasen
491be3601d Mention Vala
svn path=/trunk/; revision=7165
2008-07-06 04:17:36 +00:00
Michael Natterer
25e2e9fa28 glib/Makefile.am don't comment out the include of Makefile.decl just
2008-06-24  Michael Natterer  <mitch@imendio.com>

	* glib/Makefile.am
	* gobject/Makefile.am: don't comment out the include of
	Makefile.decl just because there are no tests. It needs to be
	included in each Makefile.am or make check will fail.


svn path=/trunk/; revision=7098
2008-06-24 20:29:24 +00:00
Stefan Kost
ba729be6c1 Unify the Makefiles. In glib only scan glib folders.
* glib/Makefile.am:
	* gobject/Makefile.am:
	  Unify the Makefiles. In glib only scan glib folders.


svn path=/trunk/; revision=7094
2008-06-22 16:34:30 +00:00
Stefan Kost
ac94781e28 Move some content for gobject-unused.sgml and cleared empty entries. The
* docs/reference/gobject/tmpl/gobject-unused.sgml:
	* gobject/gobject.h:
	* gobject/gtype.c:
	* gobject/gtype.h:
	  Move some content for gobject-unused.sgml and cleared empty entries.
	  The remaining 4 ones should be checked by some else. If they are not
	  needed. The file can be removed.


svn path=/trunk/; revision=7087
2008-06-22 10:10:59 +00:00
Stefan Kost
43c995df17 Migrating docs.
* docs/reference/gobject/tmpl/value_collection.sgml:
	* gobject/gvaluecollector.h:
	  Migrating docs.


svn path=/trunk/; revision=7086
2008-06-22 09:53:11 +00:00
Stefan Kost
80326e2433 Migrating docs.
* docs/reference/gobject/tmpl/value_arrays.sgml:
	* gobject/gvaluearray.c:
	* gobject/gvaluearray.h:
	  Migrating docs.


svn path=/trunk/; revision=7085
2008-06-22 09:45:13 +00:00
Stefan Kost
356fe46531 Migrating docs.
* docs/reference/gobject/tmpl/signals.sgml:
	* gobject/gclosure.c:
	* gobject/gobject.c:
	* gobject/gsignal.c:
	* gobject/gsignal.h:
	  Migrating docs.


svn path=/trunk/; revision=7083
2008-06-22 09:29:52 +00:00
Stefan Kost
0f62f41d2c Help poor little gtkdoc a bit and tell that it can ignore G_GNUC_INTERNAL.
* docs/reference/gobject/Makefile.am:
	  Help poor little gtkdoc a bit and tell that it can ignore
	  G_GNUC_INTERNAL. Also disable including the unit-test header as this
	  causes warnings and we don't need it here.


svn path=/trunk/; revision=7082
2008-06-21 22:38:08 +00:00
Stefan Kost
fca3fb5818 Migrating docs.
* docs/reference/gobject/tmpl/param_value_types.sgml:
	* gobject/gboxed.c:
	* gobject/gboxed.h:
	* gobject/genums.c:
	* gobject/genums.h:
	* gobject/gobject.c:
	* gobject/gobject.h:
	* gobject/gparam.c:
	* gobject/gparam.h:
	* gobject/gparamspecs.c:
	* gobject/gparamspecs.h:
	* gobject/gvaluetypes.c:
	* gobject/gvaluetypes.h:
	  Migrating docs.


svn path=/trunk/; revision=7081
2008-06-21 22:16:14 +00:00
Stefan Kost
fedbbf5d74 Migrating docs.
* docs/reference/gobject/tmpl/objects.sgml:
	* gobject/gobject.c:
	* gobject/gobject.h:
	* gobject/gparam.h:
	  Migrating docs.


svn path=/trunk/; revision=7080
2008-06-21 20:07:57 +00:00
Stefan Kost
3f5419f6f1 Migrating docs.
* docs/reference/gobject/tmpl/gtypeplugin.sgml:
	* gobject/gtypeplugin.c:
	* gobject/gtypeplugin.h:
	  Migrating docs.


svn path=/trunk/; revision=7079
2008-06-21 18:20:43 +00:00
Stefan Kost
f22d19fc34 Add --sgml-mode to allow sgml in doc-fragments (which somehow works before
* docs/reference/gobject/Makefile.am:
	  Add --sgml-mode to allow sgml in doc-fragments (which somehow works
	  before already).
	* gobject/gboxed.h:
	* gobject/gclosure.c:
	* gobject/gparam.c:
	* gobject/gparam.h:
	* gobject/gtype.h:
	  Convert character entities back. FIx some broken sgml.


svn path=/trunk/; revision=7078
2008-06-21 17:25:17 +00:00
Stefan Kost
f2da2e8e92 Migrating docs.
* docs/reference/gobject/tmpl/gtypemodule.sgml:
	* gobject/gtypemodule.c:
	* gobject/gtypemodule.h:
	  Migrating docs.


svn path=/trunk/; revision=7077
2008-06-21 16:35:50 +00:00
Stefan Kost
005be9980a Migrating docs.
* docs/reference/gobject/tmpl/gtype.sgml:
	* gobject/gtype.c:
	* gobject/gtype.h:
	* gobject/gvaluetypes.h:
	  Migrating docs.


svn path=/trunk/; revision=7075
2008-06-21 16:14:18 +00:00
Stefan Kost
fb07c65020 Migrating docs.
* docs/reference/gobject/tmpl/gparamspec.sgml:
	* gobject/gparam.c:
	* gobject/gparam.h:
	  Migrating docs.


svn path=/trunk/; revision=7073
2008-06-21 13:47:14 +00:00
Stefan Kost
0b9bf79ec2 Migrating docs.
* docs/reference/gobject/tmpl/generic_values.sgml:
	* gobject/gboxed.h:
	* gobject/gtype.h:
	* gobject/gvalue.c:
	* gobject/gvalue.h:
	* gobject/gvaluetypes.c:
	  Migrating docs.


svn path=/trunk/; revision=7071
2008-06-21 12:45:49 +00:00
Stefan Kost
83dd545044 Migrating docs.
* docs/reference/gobject/tmpl/gclosure.sgml:
	* gobject/gboxed.h:
	* gobject/gclosure.c:
	* gobject/gclosure.h:
	* gobject/gobject.c:
	* gobject/gsourceclosure.c:
	* gobject/gsourceclosure.h:
	  Migrating docs.


svn path=/trunk/; revision=7069
2008-06-21 12:18:12 +00:00
Stefan Kost
e7bc23623e Remove duplicated entries. They are documented and should be shown.
* docs/reference/gobject/gobject-sections.txt:
	  Remove duplicated entries. They are documented and should be shown.


svn path=/trunk/; revision=7067
2008-06-21 11:33:53 +00:00
Stefan Kost
672caa1a51 Migrating docs.
* docs/reference/gobject/tmpl/enumerations_flags.sgml:
	* gobject/genums.c:
	* gobject/genums.h:
	  Migrating docs.


svn path=/trunk/; revision=7066
2008-06-21 11:27:45 +00:00
Stefan Kost
86a0f779f6 Migrating docs.
* docs/reference/gobject/tmpl/gboxed.sgml:
	* gobject/gboxed.c:
	* gobject/gboxed.h:
	* gobject/gvaluetypes.c:
	  Migrating docs.


svn path=/trunk/; revision=7065
2008-06-21 10:19:58 +00:00
Matthias Clasen
6427d30d1f 2.17.1
svn path=/trunk/; revision=7029
2008-06-12 17:21:49 +00:00
Matthias Clasen
40334783bc Fix typos Noticed by Areg Beketovski
* glib/tmpl/macros_misc.sgml:
        * gobject/tmpl/gclosure.sgml:
        * gobject/tmpl/gtype.sgml: Fix typos
        Noticed by Areg Beketovski


svn path=/trunk/; revision=7011
2008-06-11 18:25:44 +00:00
Matthias Clasen
f9f98f1c8b Fix a typo
svn path=/trunk/; revision=7009
2008-06-11 17:56:49 +00:00
Matthias Clasen
777df550ab more doc fixage
svn path=/trunk/; revision=7008
2008-06-11 17:47:53 +00:00
Matthias Clasen
5b12bf33a4 Improve docs
svn path=/trunk/; revision=7007
2008-06-11 17:03:11 +00:00
Matthias Clasen
74820f48db Improve docs
svn path=/trunk/; revision=7006
2008-06-11 17:00:57 +00:00
Matthias Clasen
7372ce2981 Doc improvements
svn path=/trunk/; revision=7005
2008-06-11 16:35:53 +00:00
Matthias Clasen
107d1d330d fix some docs
svn path=/trunk/; revision=7004
2008-06-11 16:27:22 +00:00
Matthias Clasen
bd216ba3c8 Bug 528717 – Misprint in the description of the parameter
'type_id' for the interface g_type_register_fundamental

        * gobject/tmpl/gtype.sgml: Remove references to GTypeFundamentals
        Pointed out by Areg Beketovski


svn path=/trunk/; revision=7000
2008-06-11 15:01:11 +00:00
Matthias Clasen
90f1812309 Fix docs
svn path=/trunk/; revision=6999
2008-06-11 14:58:42 +00:00
Matthias Clasen
e0072d4441 Additions
svn path=/trunk/; revision=6994
2008-06-10 17:54:24 +00:00
14:06:34 Tim Janik
a52a14e4a9 fixed documentation regarding type checking macros that do and do not
2008-06-10 14:06:34  Tim Janik  <timj@imendio.com>

        * gobject/tmpl/gtype.sgml: fixed documentation regarding type checking
        macros that do and do not issue warnings.


svn path=/trunk/; revision=6986
2008-06-10 12:07:18 +00:00
Matthias Clasen
8b08deaaf5 Bug 535021 – g_param_spec_internal documentation should
describe purpose of nick and blurb

        * gobject/tmpl/gparamspec.sgml: Explain nicks and blurbs
        some more.

svn path=/trunk/; revision=6940
2008-05-27 14:18:14 +00:00
Matthias Clasen
9f64fa6fe9 Fix docs for g_cclosure_marshal_STRING__OBJECT_POINTER. (#534177, Areg
2008-05-25  Matthias Clasen  <mclasen@redhat.com>

        * gobject/tmpl/gclosure.sgml: Fix docs for
        g_cclosure_marshal_STRING__OBJECT_POINTER. (#534177, Areg Beketovski)

svn path=/trunk/; revision=6929
2008-05-25 19:53:47 +00:00
Matthias Clasen
537075e94c Bug 528648 – Extra >s in Object Construction section...
* gobject/tut_howto.xml: Fix a formatting glitch


svn path=/trunk/; revision=6900
2008-05-17 05:56:29 +00:00