GNOME Bugzilla – Bug 589351
API documentation migration for GAllocator and GByteArray
Last modified: 2010-04-18 18:38:23 UTC
It seems that http://live.gnome.org/GTK%2B/TaskAPIDocMigration needs some activity, after reading Stefan Kost's latest blogpost. Attaching a few patches to remove some unused documentation from gobject, and migrate a couple of SGML files in glib. I did some very minor cleanup, like removing the terminal full stop from parameter descriptions. If this is not acceptable, it's not too much trouble for me to fix.
Created attachment 138979 [details] [review] removed some unused documentation from glib
Created attachment 138980 [details] [review] migrate GAllocator docs
Created attachment 138981 [details] [review] migrate GByteArray docs
Cool. While I can technically commit those patches, please get one glib maintainer to ack. them. regarding the first patch - is this stuff that is already in the sources?
(In reply to comment #4) > Cool. While I can technically commit those patches, please get one glib > maintainer to ack. them. Sure, thanks. > regarding the first patch - is this stuff that is already in the sources? Yeah, for instance all the G_TYPE_* defines are in gobject/gtype.h, together with inline documentation. Also, the functions documented there appear to have been removed from glib in 2001: Tue Nov 13 22:16:41 2001 Tim Janik <timj@gtk.org> * gtype.[hc]: API cleanups. remove g_type_check_flags(), provide g_type_test_flags() as a *private* function. s/g_type_check_is_a/g_type_check_class_is_a/, private function. s/g_type_instance_is_a/g_type_check_instance_is_a/, also private.
(In reply to comment #1) > Created an attachment (id=138979) [details] [review] > removed some unused documentation from glib Hi David Why remove all those .tmpl files from gitignore? They're auto-generated and not included in the source control....
(In reply to comment #6) > Why remove all those .tmpl files from gitignore? They're auto-generated and > not included in the source control.... Ryan, I think the objective is not use tmpl files any more: see bug #604886
Yes, the long term goal is to not use tmpl files at all, but first the whole glib docs have to be migrated, then then makefile-flavour that does not use tmpl can be used: in configure.ac GTK_DOC_CHECK([1.10],[--flavour no-tmpl]) or export GTKDOCIZE_FLAGS="--flavour no-tmpl" in autogen.sh (before running gnome-autogen.sh).
I understand that. In the meantime though, still using template files (but having them contain no useful information) the correct approach is to gitignore them.
Comment on attachment 138979 [details] [review] removed some unused documentation from glib committed without the .gitignore changes in commit 9023ac09345d9569d11bc55d66adcfaa92d8811a
We can close this bug now as all the documentation is already ported