Bug 4478

Summary:	cairo_public decorators break documentation build
Product:	cairo	Reporter:	Bertram Felgenhauer <bertram.felgenhauer>
Component:	general	Assignee:	Carl Worth <cworth>
Status:	RESOLVED FIXED	QA Contact:	cairo-bugs mailing list <cairo-bugs>
Severity:	normal
Priority:	high
Version:	1.1.1
Hardware:	x86 (IA32)
OS:	Linux (All)
Whiteboard:
i915 platform:		i915 features:
Attachments:	simple patch to use that modified gtk-doc

Description Bertram Felgenhauer 2005-09-16 12:49:04 UTC

This is a known problem.

To reproduce: build documentation from the sources; there will be a lot of
warnings and the documentation will lack (almost?) all function descriptions.

Further insight: gtk-doc has some strict regular expressions that don't accept 
cairo_public int  as a type, for example, which causes such declarations to be
ignored.

Comment 1 Bertram Felgenhauer 2005-09-16 12:50:26 UTC

I've filed a request for feature enhancement for gtk-doc together with a patch
at http://bugzilla.gnome.org/show_bug.cgi?id=316512 .

Comment 2 Bertram Felgenhauer 2005-09-16 12:53:35 UTC

Created attachment 3298 [details] [review]
simple patch to use that modified gtk-doc

Changelog:

2005-09-16  Bertram Felgenhauer  <int-e@gmx.de>

	* doc/public/Makefile.am: add --ignore-decorators for gtk-doc

Comment 3 Bertram Felgenhauer 2006-04-28 02:52:36 UTC

My patch for gtk-doc finally made it into the 1.6 release, released Apr 9 2006.
So I guess we can go ahead with this soon.

Comment 4 Behdad Esfahbod 2006-06-29 09:54:02 UTC

patch committed.  Will be in 1.2

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.