RE: [Doxygen-users] Documenting #included files

[Trevor R. <Tre...@pe...>]

Jac,

Thanks for your reply.  If your {} trick works, it might be helpful,
although I'd rather not split the class tag from the guts of the class.

The main problem with your macro-hack variation is that I can't include
inline documentation for the class.  I'd have to use \fn style of
documentation, which I find unacceptably hard to maintain due to the
redundancy.  (In addition to my abstract buffer class, I have 3 derived
classes that need to use the same template emulation.)  A couple more
reasons: 1) It's no fun to remember to put backslashes at the end of every
line.  2) The entire class is now a big text blob that editors and other
tools don't understand, so they won't do things like syntax highlight, match
parentheses, or auto-generate doc comments.  3) I might eventually hit some
sort of maximum macro length in one of the six preprocessors I'm using.  (We
use 5 compilers on 4 platforms, plus an additional make-dependency
preprocessor on Windows since VC++ doesn't generate make dependencies.)

Anyway, it sounds like you agree on the usefulness of telling Doxygen to
document #included files.  Do you have any proposed syntax?  If you don't
have time to finish your patch for this, I could do it myself.  (I had
already assumed I'd have to add it if I wanted it.)

-Trevor


-----Original Message-----
From: Jac Goudsmit [mailto:ja...@ma...]
Sent: Wednesday, May 02, 2001 4:25 PM
To: dox...@li...
Subject: Re: [Doxygen-users] Documenting #included files


>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

_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://lists.sourceforge.net/lists/listinfo/doxygen-users