Bug 7920

Summary:	PATCH: cairomm-1.1.10 fails to build complete documentation
Product:	cairomm	Reporter:	ralf
Component:	Build	Assignee:	Murray Cumming <murrayc>
Status:	RESOLVED INVALID	QA Contact:
Severity:	normal
Priority:	high	Keywords:	patch
Version:	unspecified
Hardware:	x86 (IA32)
OS:	Linux (All)
Whiteboard:
i915 platform:		i915 features:
Attachments:	sets Doxygen flag MACRO_EXPANSION to YES

Description ralf 2006-08-19 09:36:24 UTC

due to an error in the Doxyfile, documentation within conditional macros like
PdfSurface is not included in the produced docs. the following patch fixes this.

--- Doxyfile~	2006-08-19 18:17:58.000000000 +0200
+++ Doxyfile	2006-08-19 18:21:55.000000000 +0200
@@ -174,7 +174,7 @@
 # Configuration options related to the preprocessor   
 #---------------------------------------------------------------------------
 ENABLE_PREPROCESSING   = YES
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = NO
 SEARCH_INCLUDES        = YES
 INCLUDE_PATH           =

Comment 1 ralf 2006-08-19 09:37:39 UTC

Created attachment 6604 [details]
sets Doxygen flag MACRO_EXPANSION to YES

fixes problem with not included documentation

Comment 2 Jonathon Jongsma 2006-08-19 09:44:11 UTC

Just to clarify, are you saying that you get no documentation for the PdfSurface
class?  Because it seems to get produced for me.  What version of doxygen do you
have installed?

Comment 3 ralf 2006-08-19 10:03:41 UTC

yes, there is only ImageSurface in my hierarchy. this is with doxygen-1.4.4. oh,
and the patch would have to be applied to Doxyfile.in, sorry.

Comment 4 ralf 2006-08-19 10:11:03 UTC

you may be right, I'm chasing ghosts here. it appears I earlier made my own docs
from the headers, for whatever reason, and that didn't include the classes,
obviously. I'm very sorry to have wasted your time.

Comment 5 Jonathon Jongsma 2006-08-19 10:51:49 UTC

no problem.  Thanks for taking the time to report the problem, even if it didn't
turn out to be a problem :)

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.