GNOME Bugzilla – Bug 166363
Document standard macros and functions
Last modified: 2018-05-22 13:00:23 UTC
We need to document the standard macros like these: GTK_ABOUT_DIALOG GTK_IS_ABOUT_DIALOG GTK_TYPE_ABOUT_DIALOG GTK_ABOUT_DIALOG_CLASS GTK_IS_ABOUT_DIALOG_CLASS GTK_ABOUT_DIALOG_GET_CLASS (gtk_about_dialog_get_type? - maybe we only show it if a macro like GTK_TYPE_ABOUT_DIALOG isn't defined for the widget) I suggest placing them as a group at the bottom of the Synopsis, with links to a page in the GObject docs that describes them.
shouldn't these just go to the private section? At least thats what gtk+ does. The docs for GObject (G_OBJECT, G_IS_OBJECT and so on) are right now very gobject specific. On the other hand glib-2.8 has the gobject tutorial included, so we can link to that.
The idea for standard macros was, IIRC, to have a generic explanation of them somehwere in the gobject docs, and then just link to there.
Now that the GObject-Tutorial is part of gobject api-docs I suggest to link those to this chapter: http://developer.gnome.org/doc/API/2.0/gobject/gtype-conventions.html I would first change the gobject docs a bit to provide separate hrefs for each macro (mimic a normal api page) and then come up with a patch for gtk-doc to link to these docs. Is that a good plan?
Yes, that sounds good. (Though the title for that page is disappearing under the fixed navigation bar for me, using epiphany. Is that a bug in the css code?)
fixed the css problem in cvs
It seems we should make sure the standard macros end up in the index.sgml. We could emit generic docs for them into object pages. Now we could just add those to the end of the page if the symbols are in the standard section, or otherwise just have the docs where the symbols are. Does that sound like a plan? Anything that could go wrong with that plan?
-- GitLab Migration Automatic Message -- This bug has been migrated to GNOME's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/gtk-doc/issues/2.