Commit Graph

42 Commits

Author SHA1 Message Date
Philip Withnall
e7f9ae61dc docs: Mention GInitiallyUnowned when introducing refcounts
For completeness.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Fixes: #1568
2020-12-12 18:47:00 +00:00
Philip Withnall
4f2b1e250d gobject: Standardise on the term ‘instantiatable’
Rather than using a mixture of ‘instantiable’ and ‘instantiatable’
everywhere, standardise on the term which is already in the public API.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
2020-11-02 17:22:01 +00:00
Philip Withnall
ca60cd3314 tutorial: Add private members to example code in tutorial
Add the private members referred to in the property setting/getting
example, and a finalize function for them, to make the tutorial code
more self-contained.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Helps: #1858
2019-08-29 09:20:01 +01:00
Philip Withnall
22b59c91ad tutorial: Stop referring to ->priv for example class
The class has used `G_DECLARE_FINAL_TYPE` for a while now, so doesn’t
have a `priv` struct. Private members are declared inline.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Fixes: #1858
2019-08-29 09:19:03 +01:00
Philip Withnall
61912bffb5 tutorial: Improve type safety of property usage in GObject tutorial
This means that if you compile with `-Wswitch-enum`, the compiler will
warn you about properties which you’ve forgotten to handle in
`set_property()` or `get_property()`.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Helps: #1858
2019-08-29 09:12:18 +01:00
Mohammed Sadiq
abf28c71b0 docs: Fix typo in examples 2018-04-10 20:01:40 +05:30
Emmanuele Bassi
bc277bfcef docs: Fix typo in the GObject tutorial
The description of the instance construction does not match the example.
2017-11-25 10:24:07 +00:00
Philip Withnall
bf33f1d98d docs: Replace Maman in the tutorial with a more meaningful example
Change it to a running example of a file viewer application with a file
class and various derived classes and related interfaces. Hopefully the
reader can relate to this a little better than to their maman.

https://bugzilla.gnome.org/show_bug.cgi?id=753935
2015-10-20 07:18:15 +09:00
Philip Withnall
4a5a30f716 docs: Tidy up GObject construction discussion in the GObject tutorial
Remove some outdated references to an old example, and add a row in the
table of steps in object initialization for the GObjectClass.constructed
virtual method.

https://bugzilla.gnome.org/show_bug.cgi?id=754855
2015-10-01 15:27:21 +01:00
Philip Withnall
ab9b52e69c docs: General cleanups and rewording in the GObject concepts docs
• Remove copies of function declarations from the explanation — if
   people want those, they can follow links to the reference manual.
 • Add markup to make C code more defined.
 • Remove use of first person and irrelevant name dropping.

https://bugzilla.gnome.org/show_bug.cgi?id=744060
2015-08-21 15:15:53 +01:00
Philip Withnall
cd0d605b23 docs: Mention g_clear_object() in the GObject tutorial
As an alternative to g_object_unref().

https://bugzilla.gnome.org/show_bug.cgi?id=744060
2015-08-21 15:15:53 +01:00
Philip Withnall
f9410b1647 docs: Remove pointless copy of GObject headers from tutorial
Remove a copy of the refcounting functions from gobject.h from the
GObject tutorial. It suffices to link to the functions in the API
reference.

https://bugzilla.gnome.org/show_bug.cgi?id=744060
2015-08-21 15:15:53 +01:00
Philip Withnall
92f6325509 docs: Miscellaneous formatting and wording fixes to GObject tutorial
Convert a few sections to use the passive voice, and add some more
<function> elements.

https://bugzilla.gnome.org/show_bug.cgi?id=744060
2015-08-21 15:15:53 +01:00
Philip Withnall
2aade94fcc docs: Update code examples in GObject tutorial
Use G_DECLARE_FINAL_TYPE, simplify property handling, and remove some
unnecessary braces.

https://bugzilla.gnome.org/show_bug.cgi?id=744060
2015-08-21 15:15:53 +01:00
Philip Withnall
88e011a7cf docs: Change tutorial encodings from ISO-8859-1 to UTF-8
ISO-8859-1 — that’s a blast from the past.

https://bugzilla.gnome.org/show_bug.cgi?id=744060
2015-03-03 17:25:43 +00:00
Sébastien Wilmet
66ef10eec9 docs: syntax highlighting for the code examples
In the sections Concepts, Tools and Tutorial.

https://bugzilla.gnome.org/show_bug.cgi?id=736914
2014-09-26 23:36:26 +02:00
David Rothlisberger
be7095980e gobject docs: Remove confusing acronym
In the wikipedia disambiguation page[1] the only entry that even
remotely makes sense in this context is "and so on". Google searches
for "aso memory management" and "aso garbage collection" don't yield
anything relevant.

[1] http://en.wikipedia.org/wiki/ASO

https://bugzilla.gnome.org/show_bug.cgi?id=679996
2012-08-06 10:26:45 -04:00
David Rothlisberger
bcda26a504 gobject docs: Remove incorrect reference to signals docs
The chapter on signals comes after this chapter, not before (see
"tut_gobject.xml" in docs/reference/gobject/gobject-docs.xml).

https://bugzilla.gnome.org/show_bug.cgi?id=679996
2012-08-06 10:26:44 -04:00
Javier Jardón
d18a9caf03 docs: Use latest docbook dtd: 4.5 2012-04-23 02:46:18 +01:00
Javier Jardón
9e732ab0ea docs/gobject/tutorial: Use g_object_class_install_properties 2012-01-12 14:13:07 +00:00
Javier Jardón
91713e950f docs: Use G_VALUE_INIT 2011-10-02 17:22:18 +01:00
Ryan Lortie
9829d04be8 GObject docs: resolve broken links
Some links were broken due to typos, because functionality was removed
in GLib 2.0 or for various other reasons.  Fix up as many of them as is
reasonable.
2011-09-05 18:46:59 -04:00
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
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
7211f7f8eb docs: switch to xi:inbclude for the content to save some more seconds 2010-01-07 11:34:01 +02:00
Matthias Clasen
64bc5d874f Fix some typos
svn path=/trunk/; revision=7927
2009-03-01 06:59:31 +00:00
Matthias Clasen
db830dd381 Fix some documentation typos
svn path=/trunk/; revision=7707
2008-11-28 23:53:13 +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
adae2cf59b Updates
svn path=/trunk/; revision=7201
2008-07-18 17:55:13 +00:00
Cody Russell
515f42c9ed Documentation fixes. Recommend macro type names such as
2007-11-13  Cody Russell  <bratsche@gnome.org>

        * docs/reference/gobject/gobject-docs.sgml:
        * docs/reference/gobject/tut_gsignal.xml:
        * docs/reference/gobject/tut_gtype.xml:
        * docs/reference/gobject/tut_intro.xml:
        * docs/reference/gobject/tut_tools.xml:
        * docs/reference/gobject/tut_howto.xml:
        * docs/reference/gobject/tut_gobject.xml: Documentation fixes.
        Recommend macro type names such as NAUTILUS_TYPE_WINDOW (not
        NAUTILUS_WINDOW_TYPE).  Fixed text which erroneously stated that 
        superclass initializers don't run when an object is 
        instantiated.  Fixed numerous spelling mistakes.  Minor grammar 
        edits. (#490637, Adam Dingle)


svn path=/trunk/; revision=5857
2007-11-13 07:10:42 +00:00
Stefan Kost
8ec7d6ca3f Format XML to be more editable. Describe Interfaces better. Add a footnote
* gobject/tut_gobject.xml:
* gobject/tut_gsignal.xml:
* gobject/tut_gtype.xml:
* gobject/tut_howto.xml:
* gobject/tut_intro.xml:
* gobject/tut_tools.xml:
Format XML to be more editable. Describe Interfaces better. Add a
footnote at first occurance of 'maman_'.

svn path=/trunk/; revision=5334
2007-02-10 22:08:42 +00:00
Stefan Kost
b8fcf708d0 Unify spelling of GObject and GType. Improve some wording. Update the
* gobject/tut_gobject.xml:
* gobject/tut_gsignal.xml:
* gobject/tut_gtype.xml:
* gobject/tut_howto.xml:
* gobject/tut_tools.xml:
Unify spelling of GObject and GType. Improve some wording. Update the
usage of private data. Make tables use row-spans and add id's to them.

svn path=/trunk/; revision=5327
2007-02-07 22:15:34 +00:00
Matthias Clasen
0c10536d2e s/Gnome/GNOME/g (#352156, Guillaume Desmottes)
2006-12-14  Matthias Clasen  <mclasen@redhat.com>

        * gobject/*.xml: s/Gnome/GNOME/g (#352156, Guillaume Desmottes)
2006-12-15 04:03:07 +00:00
Matthias Clasen
442ef9d902 Say that ref/unref are thread-safe now. (#322883, Christophe Fergeau)
2006-04-18  Matthias Clasen  <mclasen@redhat.com>

	* gobject/tut_gobject.xml: Say that ref/unref are thread-safe now.
	(#322883, Christophe Fergeau)
2006-04-18 18:36:44 +00:00
Stefan Kost
ee57c76a43 add @since: for _add_private, _GET_PRIVATE fix example to use ->priv and
* gobject/tmpl/gtype.sgml:
add @since: for _add_private, _GET_PRIVATE
* gobject/tut_gobject.xml:
fix example to use ->priv and not ->private
* gobject/tut_howto.xml:
fix g_type_class_add_private example
2006-02-22 14:41:14 +00:00
Mathieu Lacage
8db223409d fix lots of typos, some of which were reported by Leonardo Boshell.
2005-05-25  Mathieu Lacage <mathieu@gnome.org>

	* gobject/tut_*.xml: fix lots of typos,
	some of which were reported by Leonardo Boshell.
2005-05-27 12:04:54 +00:00
Matthias Clasen
bc9e9efbaf Add long descriptions.
2005-05-09  Matthias Clasen  <mclasen@redhat.com>

	* gobject/tmpl/value_collection.sgml:
	* gobject/tmpl/gboxed.sgml:
	* gobject/tmpl/enumerations_flags.sgml:
	* gobject/tmpl/objects.sgml: Add long descriptions.
2005-05-09 05:25:21 +00:00
Stefan Kost
9ce3590d4e merged in docs form the gobject tutorial 2005-04-22 10:27:37 +00:00
Mathieu Lacage
acba30a9eb integrate patch from Stefan Kost 2004-11-04 14:52:33 +00:00
Mathieu Lacage
9af6ab55db commit first patches from stefan, work on the chaining up section 2004-06-09 20:22:04 +00:00
Mathieu Lacage
e992ea6fb6 Initial revision 2004-01-22 18:39:45 +00:00