Philip Withnall
08a16e9143
docs: Move the GInputStream SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 14:45:51 +01:00
Philip Withnall
a8b28e312f
docs: Move the GInetSocketAddress SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 14:45:51 +01:00
Philip Withnall
55bf188365
docs: Move the GInetAddressMask SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 14:45:51 +01:00
Philip Withnall
d424383877
docs: Move the GInetAddress SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 14:45:51 +01:00
Philip Withnall
ca505f34f2
docs: Move the GFileEnumerator SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 14:45:51 +01:00
Philip Withnall
0576e82e9a
docs: Move the GFileDescriptorBased SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 14:45:51 +01:00
Philip Withnall
7e15d56013
docs: Move the GDebugControllerDBus SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 14:45:51 +01:00
Philip Withnall
0647927a65
Merge branch 'migrate-to-gi-docgen5' into 'main'
...
Switch to using gi-docgen for docs (batch 5)
See merge request GNOME/glib!3660
2023-10-23 13:00:58 +00:00
Philip Withnall
9180d9234c
docs: Move the GNetworkAddress SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
444d9be09c
docs: Move the GMount SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
c5fb817b02
docs: Move the GMenuModel SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
5ce7e8c4f9
docs: Move the GMemoryMonitor SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
663f1a64f6
docs: Move the GFilenameCompleter SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
4f9b00907e
docs: Move the GFileMonitor SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
c8abf62ff1
docs: Move the GFileIcon SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
ac6cc7e2b6
docs: Move the GEmblemedIcon SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
7418261f4e
docs: Move the GEmblem SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
396b0af3ab
docs: Move the GDrive SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
508e164056
docs: Move the GFileAttribute SECTION to Markdown
...
It needs to be in a separate page because there isn’t actually a
`GFileAttribute` type.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:43:27 +01:00
Philip Withnall
34bb869da1
docs: Move the GFileInfo SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
eefda8158e
docs: Move the GIOStream SECTION
...
Move the contents to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
71ff617159
docs: Move the GDebugController SECTION
...
Move the contents to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
bd5219a0c0
docs: Move the GDtlsConnection SECTIONs
...
Move them to the struct docs, for all DTLS classes.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
92d8da4895
docs: Move the GInitable SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
824ae3f931
docs: Move the GIcon SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
9b4bcf1a44
docs: Move the GDBusMessage SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
72b44dce76
docs: Move the GDBusAddress SECTION
...
Move it to the struct docs, although again this is a little suspect
because there is actually no `GDBusAddress` struct/type.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
ef5ca0952b
docs: Move the GContentType SECTION
...
This might not work, as `GContentType` isn’t actually a defined type
(content types are just strings). It would be a bit weird to create a
separate page for content types, though, as the functions handling them
are very method-like and feel like they should be grouped together like
methods of a class.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
b3b744aec6
docs: Move the GAsyncHelper SECTION
...
Move it to the struct docs (although this documentation is private
anyway).
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
52248a9d69
docs: Move the GActionGroupExporter SECTION
...
Move it to the struct docs.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
5ae6bcb728
docs: Move the value collection documentation to Markdown
...
It needs to be in a separate page because it’s all macros and they have
no type/class associated with them.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 13:18:13 +01:00
Philip Withnall
1d2507a7e5
Merge branch 'ebassi/gir' into 'main'
...
Generate introspection data
See merge request GNOME/glib!3636
2023-10-23 12:13:39 +00:00
Philip Withnall
a6aaa701a5
docs: Mention dependency cycle between GLib and gobject-introspection
...
And how to break that cycle.
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 11:26:53 +01:00
Philip Withnall
635100b1f5
gio: Fix invalid doc links
...
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 11:26:53 +01:00
Philip Withnall
016aacbda8
gobject: Fix invalid doc links
...
Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
Helps: #3037
2023-10-23 11:26:53 +01:00
Emmanuele Bassi
160e5db742
Remove old introspection data
...
We don't need it any more.
2023-10-23 11:26:53 +01:00
Emmanuele Bassi
3ffa33825b
Build the API references with the generated GIR data
...
Gate the API reference on the availability of the introspection data as
well, so we don't accidentally try and generate the documentation
without a description of our API.
2023-10-23 11:26:53 +01:00
Emmanuele Bassi
fe32c3f5c5
Generate introspection data
...
Currently, the introspection data for GLib and its sub-libraries is
generated by gobject-introspection, to avoid the cyclic dependency
between the two projects.
Since gobject-introspection is generally available on installed systems,
we can check for its presence, and generate the introspection data
directly from GLib.
This does introduce a cyclic dependency, which is why it's possible to
build GLib without introspection, then build gobject-introspection, and
finally rebuild GLib.
By having introspection data available during the GLib build, we can do
things like generating documentation; validating newly added API; and
close the loop between adding new API and it becoming available to non-C
consumers of the C ABI (i.e. language bindings).
2023-10-23 11:26:53 +01:00
Emmanuele Bassi
6e771f0e84
docs: Add missing annotation separator
2023-10-23 10:25:31 +01:00
Emmanuele Bassi
c5a1e4f6c3
docs: Remove duplicate interface field
2023-10-23 10:25:31 +01:00
Emmanuele Bassi
d026534753
docs: Replace deprecated Virtual tag
...
Use the (virtual) symbol annotation.
2023-10-23 10:25:31 +01:00
Emmanuele Bassi
47faa032cb
docs: Remove duplicate docblocks
...
The g_cclosure_marshal_* symbols are already documented in gmarshal.c.
2023-10-23 10:25:31 +01:00
Emmanuele Bassi
5e7c512609
docs: Fix various invalid links
2023-10-23 10:25:31 +01:00
Emmanuele Bassi
3013a0ef4a
docs: Fix the annotation for GSubprocessLauncher
2023-10-23 10:25:31 +01:00
Emmanuele Bassi
d3d69cb8ba
docs: Fix annotations for GSimpleProxyResolver
...
Drop "nullable" from the default-proxy property docblock, and correctly
separate the annotation from the return value's description.
2023-10-23 10:25:31 +01:00
Emmanuele Bassi
cfb11a8d63
docs: Avoid a bare "returns:"
...
Lines inside a docblock cannot begin with "returns:", as that is the tag
for the documentation of the return value.
2023-10-23 10:25:30 +01:00
Emmanuele Bassi
c86f469c1e
Ignore autocleanups when generating introspection data
2023-10-23 10:25:30 +01:00
Emmanuele Bassi
0f8aaee2bf
Add missing annotation separator
2023-10-23 10:25:30 +01:00
Emmanuele Bassi
fb84bad077
Remove unnecessary annotation
...
All pointer-based properties are nullable by definition, and the
`nullable` annotation is not accepted at the identifier level.
2023-10-23 10:25:30 +01:00
Emmanuele Bassi
c5eb130175
Fix broken annotation in GIOChannel
...
Missing separator between annotation and description.
2023-10-23 10:25:30 +01:00