Bug 36423 - Make the docs build with gtk-doc 1.16 and later
Summary: Make the docs build with gtk-doc 1.16 and later
Status: RESOLVED FIXED
Alias: None
Product: Telepathy
Classification: Unclassified
Component: tp-glib (show other bugs)
Version: unspecified
Hardware: Other All
: medium normal
Assignee: Will Thompson
QA Contact: Telepathy bugs list
URL: http://cgit.collabora.co.uk/git/user/...
Whiteboard: review+
Keywords: patch
Depends on:
Blocks:
 
Reported: 2011-04-20 06:26 UTC by Will Thompson
Modified: 2011-04-27 08:35 UTC (History)
0 users

See Also:
i915 platform:
i915 features:

Attachments

Description Will Thompson 2011-04-20 06:26:37 UTC 
With 1.16, nine entries appear in telepathy-glib-unused.txt. Three were valid: inline functions which gtk-doc previously erroneously ignored but now does not; the other six are regressions in gtk-doc <https://bugzilla.gnome.org/show_bug.cgi?id=648293>.

The attached branch fixes the first three, and works around the other six. It also fixes some other documentation nits I noticed while reading the gtk-doc output.
Comment 1 Simon McVittie 2011-04-20 06:49:43 UTC 
> This doesn't actually make gtk-doc shut up, as I hoped it would, because it
> doesn't pay the blindest bit of notice to G_GNUC_DEPRECATED and instead witters > on about deprecation guards. Oh well.

gtk-doc wants you to use:

#ifndef TP_DISABLE_DEPRECATED
insert_thing_that_is_deprecated (here);
#endif

The branch looks fine as-is.
Comment 2 Simon McVittie 2011-04-20 06:50:29 UTC 
... either as-is or with the additional change I suggested, is what I meant to say.
Comment 3 Jonny Lamb 2011-04-27 08:35:01 UTC 
Will merged this.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.