luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 23:46:15 +01:00
Code Issues Packages Projects Releases Wiki Activity
28,128 Commits 297 Branches 581 Tags 111 MiB
38c4809719
Commit Graph

8449 Commits

Author SHA1 Message Date
Philip Withnall
6c930587ad docs: Move the GDesktopAppInfo SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-25 15:10:16 +01:00
Philip Withnall
47e58fb4c6 docs: Move the GDBusObjectProxy SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-25 15:10:16 +01:00
Philip Withnall
99e25e74ef docs: Move the GDBusObjectManagerClient SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-25 15:10:15 +01:00
Philip Withnall
264ebbbb2b docs: Move the GDBusMethodInvocation SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-25 15:10:15 +01:00
Michael Catanzaro
eadbdb439e Merge branch 'meson-version-bump' into 'main' 
build: Bump Meson dependency to 1.2.0

See merge request GNOME/glib!3666
 2023-10-25 13:23:53 +00:00
Alex Richardson
d0e03f0930 GType: introduce GTYPE_TO_POINTER/GPOINTER_TO_TYPE 
On CHERI-enabled systems we use uintptr_t as the underlying storage for
GType and therefore casting to gsize strips the upper bits from a pointer.
Fix this by casting via uintptr_t instead and introduce a new set of
macros to convert between GType and pointers.
 2023-10-25 12:01:02 +01:00
Philip Withnall
7fd9045065 build: Drop pkgconfig.generate variables for builtin directories 
Meson has added these automatically since 0.62. This fixes a Meson
warning.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
 2023-10-25 11:21:24 +01:00
Philip Withnall
4ce58df854 build: Change configure_file() to fs.copyfile() when copy is set 
Meson has preferred `fs.copyfile()` since 0.62. This fixes a set of
Meson warnings.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
 2023-10-25 11:20:36 +01:00
Philip Withnall
8831f65a4d build: Drop a no-longer-needed Meson backwards compatibility check 
See the previous commit.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>
 2023-10-24 17:00:24 +01:00
Philip Withnall
051c5336d4 docs: Move the GSocketConnection SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
43b4e7e097 docs: Move the GSocketClient SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
4f4ca75b4d docs: Move the GSocketAddress SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
bd753fb87c docs: Move the GSocket SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
0b0179678a docs: Move the GSimplePermission SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
2fc8f47358 docs: Move the GSimpleIOStream SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
dcb382457d docs: Move the GSimpleAsyncResult SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
0d39a138c7 docs: Move the GSeekable SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
bea92c4882 docs: Move the GProxyAddress SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
658bb30f06 docs: Move the GPropertyAction SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
ca02613987 docs: Move the GPowerProfileMonitor SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
d9e35c264b docs: Move the GPolllable*Stream SECTIONs 
Move them to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
ed34ddc355 docs: Move the GPermission SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
723fc46223 docs: Move the GNotification SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
e044045ea4 docs: Move the GNetworkMonitor SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
ffff217a9d docs: Move the GMemory*Stream SECTIONs 
Move them to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
22275f389b docs: Move the GLoadableIcon SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
226e9f16ea docs: Move the GDBusServer SECTION 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
 2023-10-24 10:58:56 +01:00
Philip Withnall
1c2207d9fb docs: Move the GOsxAppInfo 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
cf7fd070c8 docs: Move the GNativeSocketAddress 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
f17cb81ce5 docs: Move the GMountOperation 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
47da98d7f7 docs: Move the GMenu 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
49a94280c1 docs: Move the GListStore 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
c834b843b9 docs: Move the GListModel 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
b45c554da5 docs: Move the GOutputStream 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
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
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
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
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
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
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
Philip Withnall
8629024243 tests: Skip appinfo/associations test if update-*-database not installed 
If `update-desktop-database` or `update-mime-database` are not
installed, there are a few `GAppInfo` methods for modifying file
associations which will print a `g_warning()` when called. Something
like:
```
GLib-GIO-FATAL-WARNING: Failed to execute child process ‘update-desktop-database’ (No such file or directory)
```

(Example: https://gitlab.gnome.org/zamaudio/glib/-/jobs/3190053)

This will cause the appinfo/associations test to fail, as warnings are
fatal.

If that’s going to happen, skip the test. We can’t hard-depend on these
tools as they are external to GLib and only needed for a few operations.
Instead we have a soft runtime dependency on them; that should be
reflected in the tests.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3148
 2023-10-22 23:34:00 +01:00
Damien Zammit
f25a9ca10c Initial test of Hurd CI - (run_tests.sh status ignored) 2023-10-18 23:33:04 +00:00
Philip Withnall
21c6ebf65b Merge branch 'wip/kabus/new-mtime' into 'main' 
gio: add a file copy flag for default modification time

Closes #3140

See merge request GNOME/glib!3643
 2023-10-18 14:45:49 +00:00
Aleksandr Mezin
b9c90c3a3e GApplicationCommandLine: add print[err]_literal() 
GJS (and likely other language bindigs relying on introspection)
can't use `g_application_command_line_print()`/`_printerr()`.
 2023-10-18 01:20:23 +03:00
Philip Withnall
130c2d6373 build: Fix -Dlibelf=disabled on Linux 
Commit f6c40b1d fixed libelf detection on FreeBSD (where the library has
no pkg-config file and needs to be found via `find_library()`), but
broke `-Dlibelf=disabled` on Linux, as `get_option('libelf')` was no
longer checked.

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

Fixes: #3120
 2023-10-17 15:04:19 +01:00
Matthias Clasen
2b22b43edd docs: Move the GDBusInterfaceSkeleton SECTION 
Move content to struct docs.

Helps: #3037
 2023-10-17 11:20:20 +01:00
Matthias Clasen
8c7591addf docs: Move the GDBusInterface SECTION 
Move content to struct docs.

Helps: #3037
 2023-10-17 11:20:17 +01:00
Matthias Clasen
2d1a9ed5a3 docs: Move the GDBusConnection SECTION 
Move contents to struct docs.

Helps: #3037
 2023-10-17 11:20:14 +01:00
Matthias Clasen
c0243f7eaa docs: Move the GDBusAuthObserver SECTION 
Move contents to struct docs.

Helps: #3037
 2023-10-17 11:20:12 +01:00
Matthias Clasen
985bc0fab3 docs: Move the GDBusActionGroup SECTION 
Move content to struct docs.

Helps: #3037
 2023-10-17 11:20:10 +01:00
Matthias Clasen
f39640b759 docs: Move the GDataOutputStream SECTION 
Move content to struct docs.

Helps: #3037
 2023-10-17 11:20:08 +01:00
Matthias Clasen
8371b893a2 docs: Move the GDataInputStream SECTION 
Not much to move.

Helps: #3037
 2023-10-17 11:20:06 +01:00
Matthias Clasen
081cc5af25 docs: Move the GDatagramBased SECTION 
Move contents to struct docs.

Helps: #3037
 2023-10-17 11:20:03 +01:00
Matthias Clasen
926f56c7c7 docs: Move the GCredentials SECTION 
Move contents to struct docs.

Helps: #3037
 2023-10-17 11:20:00 +01:00
Matthias Clasen
dad6ec9651 docs: Move the GConverterOutputStream SECTION 
Move content to struct docs.

Helps: #3037
 2023-10-17 11:19:57 +01:00
Matthias Clasen
b70b164ba6 docs: Move the GConverterInputStream SECTION 
Move content to struct docs.

Helps: #3037
 2023-10-17 11:19:55 +01:00
Matthias Clasen
174073722e docs: Move the GConverter SECTION 
Move the content to the struct docs.

Helps: #3037
 2023-10-17 11:19:52 +01:00
Matthias Clasen
747b81409d docs: Move the GCharsetConverter SECTION 
Not much to move here.

Helps: #3037
 2023-10-17 11:19:49 +01:00
Matthias Clasen
e267653eab docs: Move the GCancellable SECTION 
Move the contents into the struct docs.

Helps: #3037
 2023-10-17 11:19:46 +01:00
Matthias Clasen
3d5d3bceea docs: Move the GBytesIcon SECTION 
Move the contents into the struct docs.

Helps: #3037
 2023-10-17 11:19:44 +01:00
Matthias Clasen
93788dfb07 docs: Move the GAppInfoMonitor SECTION 
Move the contents to the struct docs.

Helps: #3037
 2023-10-17 11:19:41 +01:00
Matthias Clasen
bf9bf0b0cc docs: Move the GBufferedOutputStream SECTION 
Move the contents to the struct docs.

Helps: #3037
 2023-10-17 11:19:38 +01:00
Matthias Clasen
08990badb6 docs: Move the GBufferedInputStream SECTION 
Move the contents to the struct docs.

Helps: #3037
 2023-10-17 11:19:27 +01:00
Matthias Clasen
f7b5e3b37e docs: Move the GAsyncResult SECTION 
Move the content to the struct docs.

Helps: #3037
 2023-10-17 10:57:22 +01:00
Matthias Clasen
331c137ee1 docs: Move the GAsyncInitable SECTION 
Move the contents to the struct docs.

Helps: #3037
 2023-10-17 10:57:14 +01:00
Matthias Clasen
840cfd1ab7 docs: Move the GApplicationCommandline SECTION 
Move the contents to the struct docs.

Helps: #3037
 2023-10-17 10:57:10 +01:00
Matthias Clasen
75de7e8628 docs: Move the GApplication SECTION 
Move the contents to the struct docs.

Helps: #3037
 2023-10-17 10:57:06 +01:00