Matthias Clasen
35066ed6c6
Docs: Drop entities, switch away from sgml mode
...
Since all element markup is now gone from the doc comments,
we can turn off the gtk-doc sgml mode, which means that from
now on, docbook markup is no longer allowed in doc comments.
To make this possible, we have to replace all remaining
entities in doc comments by their replacement text, & -> &
and so on.
2014-02-09 02:07:26 -05:00
Matthias Clasen
5acd7b01de
Remove some informalexamples
2014-02-08 15:50:17 -05:00
Matthias Clasen
a59e3d69b4
Another stray <programlisting>
2014-02-08 15:34:04 -05:00
Matthias Clasen
c4991d24ee
Strip out a remaining programlisting
2014-02-08 15:19:24 -05:00
Matthias Clasen
ebc4347b2c
Docs: Remove an example tag that has snuck back in
2014-02-08 13:55:27 -05:00
Matthias Clasen
03b21a19ec
Docs: convert another table to a list
2014-02-08 13:47:02 -05:00
Matthias Clasen
38b1d63b24
Convert GVariantType table to a list
2014-02-08 13:43:16 -05:00
Matthias Clasen
e7fd3de86d
Eradicate links and xrefs
...
These are all replaced by markdown ref links.
2014-02-08 12:26:56 -05:00
Matthias Clasen
df990914cf
Stop using replaceable tags
2014-02-06 16:49:29 -05:00
Matthias Clasen
5baa0f2af5
Stop using <para> for ids
...
Instead, use the id support in markdown headings.
2014-02-06 16:48:49 -05:00
Matthias Clasen
3232425785
Docs: replace <literal> by `
2014-02-06 08:07:16 -05:00
Matthias Clasen
a35d8a4c77
Docs: use quotes instead of firstterm
2014-02-06 08:07:16 -05:00
Matthias Clasen
b766db0878
Docs: don't use option tags
2014-02-06 08:07:15 -05:00
Matthias Clasen
73c23d9143
Use markdown for images
2014-02-06 08:07:15 -05:00
Matthias Clasen
49c2223ee6
Use a code block instead of <screen>
2014-02-06 08:07:15 -05:00
Ryan Lortie
7f36233042
GOption: fix bug in strv mode
...
We are a bit too aggressive about freeing memory in strv mode. Only
free it in the case that we actually set the pointer to NULL.
Uncovered by the GApplication tests.
2014-02-06 12:02:53 +00:00
Matthias Clasen
cb588d4532
Convert external links to markdown syntax
2014-02-05 21:23:28 -05:00
Matthias Clasen
0cc20b7e0b
Don't use <filename> in docs
...
Switch to simpler markdown, `foo`.
2014-02-05 20:17:46 -05:00
Matthias Clasen
111803030d
Don't use <envar> in docs
...
Switch to simpler markdown, `foo`.
2014-02-05 19:32:41 -05:00
Philip Withnall
2b8edf234c
gvariant: Document the need to cast varargs when constructing GVariants
...
Slightly expand on the documentation about casting varargs when
constructing GVariants, and link to it from all the functions where it’s
a necessary consideration.
Add an example of passing flags to a ‘t’ type variable (guint64).
Assuming the flags enum does not have many members, the flag variable
will be 32 bits wide, and needs an explicit cast to be passed into
g_variant_new() as a 64-bit value.
https://bugzilla.gnome.org/show_bug.cgi?id=712837
2014-02-05 09:40:49 +00:00
Ryan Lortie
3f3d2976d1
return_if_fail vs. return_val_if_fail fix
2014-02-04 14:23:14 +00:00
Ryan Lortie
14e62d1fa2
add GVariantDict
...
...the long-requested mutable dictionary helper for GVariant.
https://bugzilla.gnome.org/show_bug.cgi?id=625408
2014-02-04 11:56:06 +00:00
Matthias Clasen
c8476e9f8f
Fix a typo
2014-02-03 17:10:45 -05:00
Philip Withnall
5d71376763
gmain: Note that g_source_destroy() can be called multiple times
...
https://bugzilla.gnome.org/show_bug.cgi?id=723360
2014-02-03 07:55:44 +00:00
Emmanuele Bassi
ecadb5a92d
tests: Remove a compiler warning
2014-02-02 09:35:17 +00:00
Emmanuele Bassi
a2c42b4a79
array: Remove a compiler warning
...
The GRealPtrArray variable is not necessary: we're accessing only public
fields of GPtrArray.
2014-02-02 09:30:30 +00:00
Emmanuele Bassi
017349823c
array: Fix compilation
2014-02-02 09:28:31 +00:00
Matthias Clasen
d8bbc77cb3
GVariant: Convert docs to markdown
...
Specifically, convert the sections to markdown syntax.
2014-02-01 21:48:35 -05:00
Matthias Clasen
9b6cc973a0
Don't use the varname tag
...
This is just an environment variable, after all.
2014-02-01 21:41:57 -05:00
Matthias Clasen
d282bd3929
gmain: Convert docs to markdown
...
Specifically, convert sections to markdown syntax and
drop all the para tags.
2014-02-01 21:40:10 -05:00
Matthias Clasen
ce87d6420c
Don't use the quote tag
...
It was only used in two places, and we can easily do without.
2014-02-01 21:19:00 -05:00
Matthias Clasen
2f26bad026
Remove an unnecessary paragraph
2014-02-01 20:54:18 -05:00
Matthias Clasen
8945da08ac
Make gtk-doc find another symbol
2014-02-01 20:53:50 -05:00
Matthias Clasen
efae1126db
GTree: formatting fixes
2014-02-01 20:53:17 -05:00
Matthias Clasen
26b4f6b41c
gstrfuncs: Fix up gtk-doc warnings
2014-02-01 20:51:53 -05:00
Matthias Clasen
71d842674f
grand: formatting cleanups
2014-02-01 20:50:57 -05:00
Matthias Clasen
3bbd15383f
Formatting cleanups
2014-02-01 20:50:33 -05:00
Matthias Clasen
ca462d1b59
Avoid another gtk-doc warning
2014-02-01 20:49:59 -05:00
Matthias Clasen
acdd7015fb
Avoid a gtk-doc warning
2014-02-01 20:49:21 -05:00
Matthias Clasen
7548dab959
GIOChannel: Move some docs where they are looked for
2014-02-01 20:48:52 -05:00
Matthias Clasen
23dd2b01a1
Avoid some gtk-doc warnings
2014-02-01 20:47:23 -05:00
Matthias Clasen
a556afc970
Drop another use of xinclude
2014-02-01 20:46:43 -05:00
Matthias Clasen
cbd585495c
GArray: Documentation cleanups
2014-02-01 20:46:29 -05:00
Matthias Clasen
8f57d6dd1d
Docs: Avoid a 'returns' at the beginning of the line
...
This confuses gtk-doc.
2014-02-01 20:43:53 -05:00
Matthias Clasen
1c33c14c04
Add some more deprecation guards to shut up gtk-doc
2014-02-01 20:43:01 -05:00
Matthias Clasen
306dfb3292
Drop use of the command tag
...
It is more useful to link to the included man page, anyway.
2014-02-01 15:26:38 -05:00
Matthias Clasen
adf892e96a
Annotate all examples with their language
...
The C ones, at least.
2014-02-01 15:11:49 -05:00
Matthias Clasen
77c4ff80dc
docs: Stop using the function tag
2014-02-01 12:19:04 -05:00
Matthias Clasen
faa007c827
Don't use computeroutput tag
...
There was one occurrence of this.
2014-02-01 12:09:14 -05:00
Matthias Clasen
42cf80780b
Docs: Big entity cleanup
...
Strip lots of entity use from |[ ]| examples (which are now
implicit CDATA). Also remove many redundant uses of <!-- -->.
2014-02-01 12:00:30 -05:00
