William Jon McCann
469d333aa2
docs: use Returns: consistently
...
Instead of Return value:
2014-02-19 18:56:05 -05:00
Matthias Clasen
c779b42476
Docs: use // for comments in examples
...
Without sgml mode, we can't escape /* as /* anymore,
so just switch to // for comments in examples.
2014-02-14 23:34:22 -05:00
William Jon McCann
37a8ee6e95
docs: fully break lines in examples
...
Try to do a better job of keeping example content
from being too wide. It is often rendered as <pre>
text so the only time we can wrap it is in the source.
It is best to full break lines at all punctuation and
to try to keep the width under 70 chars or so.
2014-02-12 18:42:50 -05:00
Matthias Clasen
7f6a964c47
Docs: Remove all entities and turn off sgml mode
...
With all element markup gone, it is time to turn off
sgml mode, and get rid of entities as well.
2014-02-09 17:58:07 -05:00
William Jon McCann
13998c55e7
docs: use proper quotations instead of '*'
2014-02-07 14:22:39 -05:00
William Jon McCann
e34bd4137d
docs: use apostrophes in *n't
2014-02-07 13:32:47 -05:00
William Jon McCann
7a208fbbf3
docs: use proper apostrophe
...
https://wiki.gnome.org/Design/OS/Typography
2014-02-07 13:06:10 -05:00
William Jon McCann
0ce016650b
docs: Use markup for links
2014-02-07 09:42:12 -05:00
William Jon McCann
2a45418b67
docs: use proper quotes
2014-02-05 15:08:42 -05:00
William Jon McCann
a22358c0c0
docs: use ` instead of <literal>
2014-02-04 18:24:29 -05:00
William Jon McCann
7dcbfe119f
docs: don't use <quote>
2014-02-04 17:42:22 -05:00
William Jon McCann
63e887e165
docs: replace all <examples> with markdown headings
2014-02-04 16:58:54 -05:00
Matthias Clasen
30cc1512e6
Docs: Use markdown for lists
...
This greatly reduces the amount of xml in the docs.
2014-02-02 01:07:39 -05:00
William Jon McCann
e31ebda1d7
docs: don't escape entities in example code
...
https://bugzilla.gnome.org/show_bug.cgi?id=723119
2014-01-29 12:45:49 -05:00
William Jon McCann
4c8bd8e7cf
docs: Identify examples that are C code
...
https://bugzilla.gnome.org/show_bug.cgi?id=723119
2014-01-29 12:45:49 -05:00
William Jon McCann
768bc44081
docs: use |[ ]| instead of <programlisting></programlisting>
...
https://bugzilla.gnome.org/show_bug.cgi?id=723119
2014-01-29 12:45:49 -05:00
William Jon McCann
2d003553e8
docs: don't use <emphasis>
...
It is a little heavy handed. The text can speak for itself.
2014-01-28 02:02:05 -05:00
William Jon McCann
0a1d276f4f
docs: don't use <type> tags
...
Use # syntax where appropriate.
2014-01-28 00:21:26 -05:00
William Jon McCann
bf35c77f14
docs: use () instead of <function> tags
2014-01-27 23:08:08 -05:00
William Jon McCann
4a2043cbd2
docs: don't use footnotes
...
Temporarily remove documentation for keybinding signals for
GtkFileChooserDefault until we can find a way to add them
properly.
2014-01-27 22:32:24 -05:00
William Jon McCann
22586ea7c2
docs: use #*-struct instead of <structname>
2014-01-27 19:59:55 -05:00
William Jon McCann
89a51bd15d
docs: fix improper description of GtkTreeModel "rows-reordered" iter
...
https://bugzilla.gnome.org/show_bug.cgi?id=698398
2014-01-22 01:21:27 -05:00
William Jon McCann
98a5d3234d
docs: fix link to DND info
2014-01-21 18:57:37 -05:00
Simon Feltman
efa8956718
Add introspection friendly version of gtk_tree_path_new_from_indices
...
Add gtk_tree_path_new_from_indicesv which takes an array of
integers with a length. Use "Rename to" annotation to rename the
method as gtk_tree_path_new_from_indices. This is needed because
the original method takes variadic arguments which is not supported
by introspection.
https://bugzilla.gnome.org/show_bug.cgi?id=706119
2014-01-05 11:23:41 -08:00
Jasper St. Pierre
ddb4034e8e
Fix GI warnings
2013-10-09 14:19:54 -04:00
Phil Clayton
59c4fb9d6a
Add missing introspection annotations
...
https://bugzilla.gnome.org/show_bug.cgi?id=707519
2013-09-10 17:20:15 -04:00
Simon Feltman
ab13787985
Add gtk_tree_model_rows_reordered_with_length introspectable method
...
Add introspection friendly version of gtk_tree_model_rows_reordered
with a "_with_length" suffix. This allows language bindings to
safely pass an array with length argument. Use the "Rename to:"
annotation to expose as "gtk_tree_model_rows_reordered".
https://bugzilla.gnome.org/show_bug.cgi?id=684558
2013-07-22 13:39:24 -07:00
David King
c627b22126
docs: Improve GtkTreeModel iteration pattern
...
Iterating over the model in this way means that use of continue is less
error-prone, as the increment is part of the loop construct.
https://bugzilla.gnome.org/show_bug.cgi?id=548793
2012-11-22 21:36:46 +00:00
David King
da1a90bcaf
docs: Correct gtk_tree_row_reference_new() description
...
Remove the text that mentions listening to tree model signals, and
instead say that any changes are automatically propagated.
https://bugzilla.gnome.org/show_bug.cgi?id=478344
2012-05-04 03:04:58 +01:00
Javier Jardón
9d0febc9a6
Change FSF Address
2012-02-27 17:06:11 +00:00
Cosimo Cecchi
0c135cbf2c
treemodel: document gtk_tree_path_free() as allow-none
...
https://bugzilla.gnome.org/show_bug.cgi?id=662230
2011-10-20 09:27:17 -04:00
Javier Jardón
0853ce3077
Use G_VALUE_INIT
...
Instead of an explicit { 0, } when declaring the variable.
2011-10-15 16:45:16 +01:00
Matthias Clasen
5ff8fe6971
Documentation fixes
...
Mostly making sure that return values and varargs don't loose
their docs.
2011-09-25 21:04:49 -04:00
Kristian Rietveld
a91868496a
Fix typo in doc comment
2011-08-22 21:30:35 +02:00
Kristian Rietveld
85d4a5abc7
GtkTreeModel: add more detailed documentation on reference counting
2011-08-22 21:30:34 +02:00
Kristian Rietveld
2f5fbcd10a
Make _get_iter invalidate iterators when FALSE is returned
2011-08-22 21:30:29 +02:00
Matthias Clasen
2833cc2327
Change GtkTreePath to grow exponentially
...
To avoid quadratic behaviour when building up
paths by repeated appending indices. Bug 634491.
2011-05-31 22:10:58 -04:00
Tristan Van Berkom
f632956166
Fixed GtkTreeModel::row-deleted documentation
...
This documentation was in direct conflict with the documentation
of gtk_tree_model_row_deleted() docs, the function docs are TRUE,
the signal docs were FALSE, fixed.
2011-03-09 15:06:45 +09:00
Pavel Holejsovsky
374e76a19d
[GI] Mark unintrospectable constructs as (skip)
...
Also adds 'Rename to:' annotation to some constructs replacing the
skipped ones.
2011-01-20 13:57:21 +01:00
Pavel Holejsovsky
3c8fc21e9b
[GI] Fixes of existing incorrect annotations
2011-01-20 13:56:06 +01:00
Matthias Clasen
76de8aa790
Move GtkTreeModel docs inline
2011-01-12 18:50:45 -05:00
Szilárd Pfeiffer
8219ed3a26
Add gtk_tree_model_iter_previous() vfunc
...
https://bugzilla.gnome.org/show_bug.cgi?id=128058
2011-01-05 23:39:11 -05:00
Matthias Clasen
e0aa12eb0a
Tons of transfer annotations
2010-09-21 00:18:11 -04:00
Matthias Clasen
8e117b6f3a
Add a rename-to annotation for gtk_tree_path_get_indices_with_depth
...
https://bugzilla.gnome.org/show_bug.cgi?id=621590
2010-09-19 01:15:17 -04:00
Christian Persch
ffa07ee21e
Use G_DEFINE_BOXED_TYPE
...
Bug #627214 .
2010-08-18 15:34:47 +02:00
Tomeu Vizoso
813da6a39a
gtk_tree_model_iter_next's iter is (in), not (inout)
2010-08-17 17:43:04 +02:00
Christian Dywan
2a12f74c8e
Clarify memory management of tree models
...
It helps to be explicit about these things.
Bug 609264.
2010-08-09 21:35:26 -04:00
Philip Withnall
080e8ab0a8
Add (inout) annotation to gtk_tree_model_iter_next()
...
Closes: bgo#625650
2010-08-05 00:53:36 +01:00
Javier Jardón
0a07e9733b
gtk/: fully remove gtkalias hacks
...
https://bugzilla.gnome.org/show_bug.cgi?id=623845
2010-07-10 02:51:26 +02:00
John (J5) Palmieri
b74ee87b17
annotation (transfer-none) fix that somehow got dropped from last patch
...
* gtk_tree_path_get_indices_with_depth - annotate the return as 'transfer none'
to avoid double frees
2010-07-08 15:26:55 -04:00