Bug 176416

Summary:	documentation for kdeversion.h.cmake is hard to find and incomplete
Product:	[I don't know] kde	Reporter:	urwald <urwald>
Component:	general	Assignee:	Unassigned bugs mailing-list <unassigned-bugs>
Status:	VERIFIED FIXED
Severity:	normal	CC:	winter
Priority:	NOR
Version:	unspecified
Target Milestone:	---
Platform:	Compiled Sources
OS:	Unspecified
Latest Commit:		Version Fixed In:
Sentry Crash Report:
Attachments:	add-ingroup.diff add-ingroup-and-cmakedef-doc.diff

Description urwald 2008-11-29 09:22:22 UTC

Version:            (using Devel)
Installed from:    Compiled sources

Since Bug 175581 is solved, there is documentation for kdeversion.h.cmake avaible in the KDE api documentation. However, this documentation has 2 weakness:

1.) It is hard to find in the documentation for the macros of this file. It would be nice to have the macros in the module "KDE macros" (http://api.kde.org/4.x-api/kdelibs-apidocs/kdecore/html/group__KDEMacros.html). I asume this can be done adding " * @ingroup KDEMacros" in the respective parts of kdeversion.h.cmake?

2.) There is no documentation available for the macros who are defined with #cmakedefine instead of #define. Is it possible to simple add something like " * @def KDE_VERSION_MAJOR", so that doxygen creates the respective documentation? Or will doxygen ignore this documentation when it doesn't find the respective macro?

You see, I'm not an expert in doxygen. However I've created 2 patches to propose them here for review: add-ingroup.diff solves issue 1. add-ingroup-and-cmakedef-doc.diff tries to solve issue 1 and 2. Maybe they help...

Comment 1 urwald 2008-11-29 09:23:43 UTC

Created attachment 28914 [details]
add-ingroup.diff

Comment 2 urwald 2008-11-29 09:24:01 UTC

Created attachment 28915 [details]
add-ingroup-and-cmakedef-doc.diff

Comment 3 Allen Winter 2008-11-30 00:46:33 UTC

SVN commit 890720 by winterz:

Better doxygen for making the doc for these macros easier to find in the output.
Patch from Tim Fechtner.
BUG: 176416



 MM +154 -137  kdeversion.h.cmake  


WebSVN link: http://websvn.kde.org/?view=rev&revision=890720

Comment 4 urwald 2008-12-01 06:23:23 UTC

Thanks.