[Doxygen-develop] doxygen preprocessor, not always expands
Brought to you by:
dimitri
From: Stefan K. <ko...@im...> - 2003-12-08 12:37:41
|
hi dimitri and others, I am using Doxygen version 1.3.3. In the documentation of a C based project I have the following situation : === header1.h struct GitkWidget { #define GitkWidgetFields \ gchar *id; /**< @brief string identification */\ GitkContextPtr context; /**< @brief context the widget belongs to */\ GitkWidgetType type /**< @brief what kind of widget is it */ GitkWidgetFields; }; === header2.h #include "header1.h" struct GitkrGtkWidget { GitkWidgetFields; GtkWidget *impl; /**< @brief the widget implementation */ }; === Doxyfile ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES SKIP_FUNCTION_MACROS = YES === === Problem 1: when running doxygen it expands the macro there, but complains about undocumented variables. Are the documentes inside the define dropped? header1.h:6:Warning: Member id of class GitkWidget is not documented. header1.h:6:Warning: Member context of class GitkWidget is not documented. header1.h:6:Warning: Member type of class GitkWidget is not documented. === Problem 2: it does not expand the define in the second header file. Both, the data-fields list and the graph are missing the 'inherited' elements. header2.h:3:Warning: Member GitkWidgetFields of class GitkrGtkWidget is not documented. === Anyway, does anyone has a better idea, of how to do 'inheritance' in C (not C++). Unfortunately I am bound to use gcc 2.95 and this one does not support anonymous structs/unions. Wouldn't it be a good idea to have a @extends command (which should not be used in C++/Java) so that I call documents such relations even in C. Ciao Stefan -- \|/ Stefan Kost <@ @> private business +-oOO-(_)-OOo------------------------------------------------------ - - - - - | __ Address Simildenstr. 5 HTWK Leipzig, Fb IMN, Postfach 301166 | /// 04277 Leipzig 04251 Leipzig | __ /// Germany Germany | \\\/// Phone +49341 2253538 +49341 30766101 | \__/ EMail st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de | WWW www.sonicpulse.de www.imn.htwk-leipzig.de/~kost/about.html ===-=-=--=---=---------------------------------- - - - - - |