After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 743018 - gobject: Add more cross-links between documentation pages
gobject: Add more cross-links between documentation pages
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
unspecified
Other All
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2015-01-16 09:46 UTC by Philip Withnall
Modified: 2015-08-19 11:55 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
gobject: Cross-link from GType reference docs to GType conventions page (2.26 KB, patch)
2015-01-16 09:46 UTC, Philip Withnall
committed Details | Review
gobject: Add cross-links from GObject reference docs to tutorials (1.26 KB, patch)
2015-01-16 09:46 UTC, Philip Withnall
committed Details | Review

Description Philip Withnall 2015-01-16 09:46:02 UTC
If someone goes to the GObject or GType reference documentation pages, e.g. because they typed ‘GObject’ in Devhelp’s search box, they should be able to easily find the GObject tutorial and overview documents. Otherwise, those documents never get read.
Comment 1 Philip Withnall 2015-01-16 09:46:05 UTC
Created attachment 294657 [details] [review]
gobject: Cross-link from GType reference docs to GType conventions page

Make it a little easier to find the GType conventions page, which I
guess should be the canonical guide to how to name things.

This adds a brief mention of the valid characters in a type name to the
conventions page.
Comment 2 Philip Withnall 2015-01-16 09:46:09 UTC
Created attachment 294658 [details] [review]
gobject: Add cross-links from GObject reference docs to tutorials

Add some brief links from the GObject reference documentation to the
existing tutorial and overview sections on GObjects.
Comment 3 Emmanuele Bassi (:ebassi) 2015-08-19 10:58:03 UTC
Review of attachment 294657 [details] [review]:

Looks good.
Comment 4 Emmanuele Bassi (:ebassi) 2015-08-19 10:58:27 UTC
Review of attachment 294658 [details] [review]:

Looks good.
Comment 5 Philip Withnall 2015-08-19 11:55:14 UTC
Attachment 294657 [details] pushed as 9874fe3 - gobject: Cross-link from GType reference docs to GType conventions page
Attachment 294658 [details] pushed as c5cd1c5 - gobject: Add cross-links from GObject reference docs to tutorials