[Bug 176416] New: documentation for kdeversion.h.cmake is hard to find and incomplete

[Tim Fechtner]

http://bugs.kde.org/show_bug.cgi?id=176416

           Summary: documentation for kdeversion.h.cmake is hard to find and
                    incomplete
           Product: kde
           Version: unspecified
          Platform: Compiled Sources
        OS/Version: unspecified
            Status: UNCONFIRMED
          Severity: normal
          Priority: NOR
         Component: general
        AssignedTo: unassigned-bugs at kde.org
        ReportedBy: timmi at gmx-topmail.de


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...


-- 
Configure bugmail: http://bugs.kde.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.