Matthias Clasen
2f6140c066
docs: Clarify the cairo interaction section
...
This was giving outdated advice.
2024-04-28 23:54:55 -04:00
Matthias Clasen
2c1590001f
Sync cursor images with Adwaita
...
Several cursor metaphors were changes in Adwaita. Update our docs
and the Cursors demo to match.
2024-03-20 13:19:12 -04:00
Maximiliano Sandoval
6f2d33369b
docs: Add favicons
...
Requires gi-docgen main.
2024-01-25 17:06:24 +01:00
Emmanuele Bassi
48ea2ecac3
docs: Add content_base_url
...
Newer versions of gi-docgen support linking the rendered content files
to its source inside the repository, just like a symbol docblock.
2023-11-24 16:50:41 +00:00
Emmanuele Bassi
f73a7e29ca
docs: Use consistent style for content metadata
2023-11-24 16:50:41 +00:00
Emmanuele Bassi
2eb6e3d4c5
docs: Clean up the key value content file
...
Use a more descriptive title, add links to the API, add code elements,
and align the text a bit better.
2023-11-24 16:50:41 +00:00
kramo
0b2cebe3d8
docs: Update cursor images
2023-09-21 19:51:11 +02:00
Matthias Clasen
6af55a31d7
build: Rename docs build options
...
Rename gtk_doc to documentation and update_screenshots
to screenshots. The old names are still accepted.
2023-08-04 22:30:13 -04:00
Corey Berla
e418656a04
docs: Fix dependency names
...
When gi-docgen added the "related" key, it also began checking
that the dependencies were actually dependencies otherwise they aren't
listed as dependencies. The capitalization needs to match the
namespace.
2023-01-13 14:24:33 -08:00
Pedro Sader Azevedo
32e138689e
Link the file mentioned as a reference for key values
2022-11-06 01:54:38 +00:00
Manuel Zabelt
93636d4c5a
Update docs/reference/gdk/gdk4-x11.toml.in
2022-05-24 13:37:43 +00:00
Manuel Zabelt
88f761f2c8
GDK is LGPL-2.1-or-later not GPL-2.1-or-later, right?
2022-05-24 13:36:07 +00:00
Emmanuele Bassi
7a608bda27
docs: Split dependencies from related libraries
...
We currently list everything as a dependencies, regardless of whether
it actually is; this is a source of confusion for users that read the
GTK documentation.
Gi-docgen has a new "related" key in the project configuration which
allows us to list libraries that are merely related to the namespace
we are documenting; the "dependencies" key is used to document the
actual namespace dependencies, now.
2022-02-12 17:28:00 +00:00
Emmanuele Bassi
96d28738c9
docs: Point source links to the correct branch
...
The default development branch for GTK is now "main".
2022-01-13 14:39:03 +00:00
Emmanuele Bassi
39e4e48fdc
docs: Enable OpenSearch on our references
...
By adding the `docs_url` key in the project configuration file,
gi-docgen will generate an OpenSearch XML file, which allows to add
docs.gtk.org/<reference> as a "search engine" in web browsers.
2021-11-15 15:31:35 +00:00
Hodong Kim
0632e94e68
Fix typos
2021-11-07 16:48:39 +09:00
Emmanuele Bassi
142571d0b8
build: Collect gi-docgen's common arguments
...
And only enable `--fatal-warnings` if `-Dwerror` has been set, just like
we do for the introspection data generation.
2021-11-01 13:00:51 +00:00
Emmanuele Bassi
c7bb4a9678
docs: Add GdkPixbuf to the URL map
...
Allow cross-linking to the GdkPixbuf reference.
2021-10-09 10:55:24 +01:00
Emmanuele Bassi
6c0633ef61
docs: Update the URL for related documentation
...
And install the gi-docgen project files for GDK.
2021-07-31 19:05:33 +01:00
Emmanuele Bassi
f9f9fa6dc6
docs: Fix the license field
...
It's LGPL-2.1-or-later, not GPL.
2021-06-03 09:11:09 +01:00
Emmanuele Bassi
6d06b0f076
Enable fatal warnings when build the docs
...
We want to fail the CI pipeline when the documentation generator emits a
warning.
2021-05-25 13:32:32 +01:00
Matthias Clasen
71aac48042
docs: More syntax fixes
...
[`func@Foo`] is not the right link syntax either.
2021-05-22 21:20:10 -04:00
Matthias Clasen
2d0957b732
docs: Clean up docs syntax
...
Replace leftover gtk-doc syntax (#Type) with backquotes.
2021-05-21 15:34:47 -04:00
Emmanuele Bassi
29382360ed
docs: Add missing extra files for gdk4 sub-references
...
The Wayland and X11 references need the gtk-logo.svg and the urlmap.js
extra files.
Fixes : #3905
2021-04-28 01:44:47 +01:00
Emmanuele Bassi
7bfff6c51e
docs: Update the links to the docs of GTK dependencies
...
Use docs.gtk.org where appropriate.
Fixes : #3817
2021-03-31 20:51:27 +01:00
Emmanuele Bassi
7c29847fbf
build: Install the API references
...
We are building them, but not installing them.
2021-03-12 11:32:09 +00:00
Emmanuele Bassi
66f0547ebf
docs: Fix the dependencies links
...
Use the GitLab pages location until we can link to a proper space on
developer.gnome.org.
2021-03-12 11:18:37 +00:00
Emmanuele Bassi
c5ddf5b381
docs: Add URL maps for cross links
2021-03-11 16:46:02 +00:00
Emmanuele Bassi
61712bfb3b
docs: Enable search
2021-03-11 16:37:38 +00:00
Emmanuele Bassi
90cf6bb686
docs: Show class hierarchy in the API references
2021-03-11 16:37:38 +00:00
Matthias Clasen
93326164e2
docs: Add backend links to the gdk docs
...
These are placeholders for when we know how to
link across namespaces.
2021-03-11 16:37:31 +00:00
Matthias Clasen
b78895e449
docs: Add separate toml files for gdk backends
...
Reusing the same one duplicates the standalone
docs, which doesn't quite seem right.
2021-03-11 16:37:31 +00:00
Matthias Clasen
e82d090bf5
docs: Add some links to the pango chapter
2021-03-11 16:37:31 +00:00
Matthias Clasen
3d04c0f4be
docs: Move GdkEvent docs inline
...
This is not really worth a chapter of its own.
2021-03-11 16:37:31 +00:00
Emmanuele Bassi
6d489a9e81
docs: Generate the DevHelp file for our namespaces
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
701f1b837b
docs: Show summary in the namespace index
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
3ef95b4065
build: Quiet down gi-docgen
...
We are only interested in the warnings and errors.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
6f93e63d21
docs: Move detached sections into their own content file
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
b9f0cf1c8b
docs: Move gdkcairo section to an external file
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
a6ee0dd8aa
docs: Drop gtk-doc files
...
We don't use gtk-doc to generate our API reference, so we don't need its
files lying around any more.
2021-03-11 16:37:30 +00:00
Emmanuele Bassi
0ba2a3a191
Generate GTK API reference(s) with gi-docgen
...
Stop using gtk-doc, and switch to gi-docgen.
The gi-docgen tool generates API references through the introspection
data, which has various benefits:
- it does not parse C code
- it does not generate and run C code to introspect types at build time
- it does not present a different API from the one we're exporting
Additionally, gi-docgen:
- does not generate DocBook XML in order to generate HTML
- does not go through xsltproc
- parses proper Markdown
Which makes it markedly faster than gtk-doc has ever been.
2021-03-11 16:37:30 +00:00
Matthias Clasen
ea19f7c360
popuplayout: Add shadow width
...
Add shadow width to the GdkPopupLayout struct. This
information is needed by the compositor to make correct
positioning decisions about popups.
2021-02-13 21:01:46 -05:00
Matthias Clasen
9595d440cf
docs: Flesh out Popup layout docs
...
We have nice illustrations for this, lets use them.
2021-01-05 08:37:23 -05:00
Emmanuele Bassi
4fb55b3270
docs: Complete symbol coverage for GDK
...
100% symbol docs coverage.
833 symbols documented.
0 symbols incomplete.
0 not documented.
What's left are just type system macros and windowing system opaque
structures.
2020-12-16 16:28:58 +00:00
Emmanuele Bassi
a6bd0c7eed
Remove stray mentions of GdkConfigureEvent
...
The event was removed, but some traces of it linger.
2020-12-15 13:58:52 +00:00
Emmanuele Bassi
ff351721b2
docs: Add missing symbols to the GDK reference
2020-12-15 13:47:40 +00:00
Emmanuele Bassi
99e0929d6c
build: Use a consistent style for Meson files
2020-12-15 12:46:59 +00:00
Jonas Ådahl
42679f2903
gdk: Replace all GDK_CONFIGURE usage with GdkSurface::layout
...
This removes the GDK_CONFIGURE event and all related functions and data
types; it includes untested changes to the MacOSX, Win32 and Broadway
backends.
2020-12-07 20:37:29 +01:00
Jonas Ådahl
3f96d4b6da
gdk: Always get shadow width via GdkToplevelSize
...
This removes the gdk_surface_set_shadow_width() function and related
vfuncs. The point here is that the shadow width and surface size can now
be communicated to GDK atomically, meaning it's possible to avoid
intermediate stages where the surface size includes the shadow, but
without the shadow width set, or the other way around.
2020-12-07 09:46:39 +01:00
Emmanuele Bassi
34197d4f8a
docs: Add more symbols to the GDK reference
2020-12-02 19:05:41 +00:00