Re: [Doxygen-users] Documenting #included files
Brought to you by:
dimitri
|
From: Jac G. <ja...@ma...> - 2001-05-02 21:27:51
|
>Could anyone (Dimitri?) tell me if it is possible to get Doxygen to
document
>the contents of a file that is #included inside another file?
Currently, the only way to force include files to get documented is by
opening them inside a curly-brace '{}' pair. My guess is that this
should work, but I didn't actually test it:
class class1
{
#include "the_rest_of_the_class_declaration"
};
class class2
{
#include "the_rest_of_the_class_declaration"
};
I have been working on a few new doxygen commands to force it to
preprocess include-files, but I'm so busy that the project is on hold
for now.
By the way, if you want to macro-hack templates, why don't you try
something like this (doxygen will understand this I think):
#define DECLARE_ARRAY_CLASS(type) \
class type##_array \
{ \
type##_array() { ... } \
~type##_array() { ... } \
\
type operator[](int index) { ... } \
...etc... \
};
DECLARE_ARRAY_CLASS(int) // declare int_array and all its methods
DECLARE_ARRAY_CLASS(char) // declare char_array and all its methods
===Jac
|