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 749173 - add gtk-doc support for libide
add gtk-doc support for libide
Product: gnome-builder
Classification: Other
Component: libide
Other Linux
: Normal normal
: ---
Assigned To: GNOME Builder Maintainers
GNOME Builder Maintainers
: 760587 (view as bug list)
Depends on:
Reported: 2015-05-09 22:53 UTC by Christian Hergert
Modified: 2016-01-17 18:56 UTC
See Also:
GNOME target: ---
GNOME version: ---

Regenerated libide.types and libide-sections.txt (36.63 KB, patch)
2016-01-17 18:48 UTC, Varun Joshi
committed Details | Review

Description Christian Hergert 2015-05-09 22:53:55 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
Comment 1 Ting-Wei Lan 2015-08-27 06:35:42 UTC
--enable-gtk-doc does not build:

gmake[4]: Entering directory '/home/lantw44/gnome/source/gnome-builder/doc/reference/libide'
  DOC   Preparing build 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[4]: *** [scan-build.stamp] Error 1
Comment 2 Ting-Wei Lan 2015-09-12 16:48:58 UTC
The problem caused by ide_makecache_target_get_type seems to be fixed.
Comment 3 Christian Hergert 2016-01-13 17:46:22 UTC
*** Bug 760587 has been marked as a duplicate of this bug. ***
Comment 4 Varun Joshi 2016-01-17 18:48:28 UTC
Created attachment 319220 [details] [review]
Regenerated libide.types and libide-sections.txt
Comment 5 Christian Hergert 2016-01-17 18:56:32 UTC
Review of attachment 319220 [details] [review]:

LGTM and distcheck passes.
Comment 6 Christian Hergert 2016-01-17 18:56:47 UTC
Attachment 319220 [details] pushed as 9edb669 - Regenerated libide.types and libide-sections.txt