GNOME Bugzilla – Bug 749173
add gtk-doc support for libide
Last modified: 2016-01-17 18:56:50 UTC
We need to start generating gtk-doc documentation for libide.
The docs should go in doc/libide/reference/
There are plenty of other gnome modules that can be looked at for reference. libpeas is probably a good example since it gets the cross-linking correct with gtk/glib/gio/etc.
We already have --enable-gtk-doc, which should get the infrastructure in place. We just need the proper setup in doc/libide/reference/ (and associated SUBDIRS in various Makefile.am).
--enable-gtk-doc does not build:
gmake: Entering directory '/home/lantw44/gnome/source/gnome-builder/doc/reference/libide'
DOC Preparing build
git.mk: Generating .gitignore
DOC Building XML
DOC Scanning header files
DOC Introspecting gobjects
.libs/libide-scan.o: In function `get_object_types':
/home/lantw44/gnome/source/gnome-builder/doc/reference/libide/libide-scan.c:62: undefined reference to `ide_makecache_target_get_type'
clang: error: linker command failed with exit code 1 (use -v to see invocation)
Linking of scanner failed:
Makefile:804: recipe for target 'scan-build.stamp' failed
gmake: *** [scan-build.stamp] Error 1
The problem caused by ide_makecache_target_get_type seems to be fixed.
*** Bug 760587 has been marked as a duplicate of this bug. ***
Created attachment 319220 [details] [review]
Regenerated libide.types and libide-sections.txt
Review of attachment 319220 [details] [review]:
LGTM and distcheck passes.
Attachment 319220 [details] pushed as 9edb669 - Regenerated libide.types and libide-sections.txt