WebKit Bugzilla
New
Browse
Log In
×
Sign in with GitHub
or
Remember my login
Create Account
·
Forgot Password
Forgotten password account recovery
NEW
283169
[GLIB] Update documentation with crosslinks syntax
https://bugs.webkit.org/show_bug.cgi?id=283169
Summary
[GLIB] Update documentation with crosslinks syntax
Lauro Moura
Reported
2024-11-15 05:13:46 PST
Currently, WebKitGTK and WPEWebKit documentation is not cross-linking items like properties, classes, signals, etc., inside the documentation paragraphs. For example:
https://webkitgtk.org/reference/webkit2gtk/stable/class.WebView.html
https://wpewebkit.org/reference/stable/wpe-webkit-2.0/class.WebView.html
vs
https://docs.gtk.org/gtk4/class.LayoutManager.html
Not sure if some tweak needed in the documentation generation or if we'll need to update the documentation syntax to the newer scheme. Related gi-docgen pr (did not check it yet):
https://gitlab.gnome.org/GNOME/gi-docgen/-/merge_requests/21
Attachments
Add attachment
proposed patch, testcase, etc.
Lauro Moura
Comment 1
2024-11-15 05:50:49 PST
Yeah, according to [1], it's a matter of using the proper syntax, which some classes like WebKitSettings already uses. For example: #WebKitWebView:is-controlled-by-automation should become [property@WebView:is-controlled-by-automation] I'm renaming the issue to better reflect this. Given the size of the task, we can keep this open and link individual issues on demand. [1]
https://gitlab.gnome.org/GNOME/gi-docgen/-/issues/75
Note
You need to
log in
before you can comment on or make changes to this bug.
Top of Page
Format For Printing
XML
Clone This Bug