Bug 175581 - no documentation for KDE_IS_VERSION
Summary: no documentation for KDE_IS_VERSION
Status: VERIFIED FIXED
Alias: None
Product: kde
Classification: I don't know
Component: general (show other bugs)
Version: unspecified
Platform: unspecified Unspecified
: NOR normal
Target Milestone: ---
Assignee: Unassigned bugs mailing-list
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-11-19 14:02 UTC by urwald
Modified: 2008-11-26 13:01 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description urwald 2008-11-19 14:02:09 UTC
Version:            (using KDE 4.1.3)

The KDE API documentation (for example at api.kde.org) hasn't any information about the macro KDE_IS_VERSION and all the other macros that are defined in kdeversion.h. (That's bad, because these marcos are very usefull, and it took me much time and a question in a forum to find out the existence of such macros.)

That's because kdeversion.h isn't avaible in the sources, but is generated on build time by CMake from the file kdeversion.h.cmake (http://websvn.kde.org/trunk/KDE/kdelibs/kdecore/util/kdeversion.h.cmake?view=markup) As this file doesn't derminate on .h or .cpp or similar, but terminates on .h.cmake, it isn't indexed by doxygen.

I don't know much about the build system and documentation system, but wouldn't it be possible to add "*.h.cmake" to the list of valid file extension in Doxyfile - so that Doxygen indexes also this file? Using "*.h.cmake" would make shure that not every .cmake file is indexed, but only these who will be transformed in header files. Advantage: simple solution. Disadvantage: The file will get documentated in it's pre-CMake version, and not in it's post-CMake version (with minor differences, in generally there isn't changed too much by CMake).

Okay, it would be nicer to index the real kdeversion.h file like it is generated by CMake - however I don't know how to realise this easyly...
Comment 1 Pino Toscano 2008-11-19 19:42:39 UTC
Allen?
Comment 2 Allen Winter 2008-11-21 02:20:53 UTC
SVN commit 887070 by winterz:

add kdeversion.h.cmake to the list of input files so we get docs for
macros like KDE_IS_VERSION.
BUG: 175581


 M  +1 -0      Mainpage.dox  


WebSVN link: http://websvn.kde.org/?view=rev&revision=887070
Comment 3 urwald 2008-11-26 13:01:13 UTC
Thanks.