doxygen-users

[Doxygen-users] including headerfiles inside extern "C"

[Tommy S. P. <TS...@ma...>]

Hi,
I'm currently working on a project implemented in C++ and having C interface
functions declared in separate h-files. The header files are included inside
extern "C" blocks, and this results in multiple define documentation blocks
in the doxygen documentation for the h-file.

The three files file.h, fileA.cpp and fileB.cpp documented using a standard
doxygen config file (although EXTRACT_ALL=YES) yields the peculiar result of
three blocks documenting the define of the headerfile - I expected only one,
as is the result when the #include's are not embedded inside an extern "C"
block. 
Does anyone have an idea of what to do ?

file.h:
	/// MEDEF doc
	#define MYDEF 1	

fileA.cpp
	extern "C" {
	  #include "file.h"
	}

	void fA() {}

fileB.cpp
	extern "C" {
	  #include "file.h"
	}

	void fB() {}


- thanks 
>Tommy Poulsen

Re: [Doxygen-users] including headerfiles inside extern "C"

[Dimitri v. H. <di...@st...>]

On Fri, Jan 04, 2002 at 10:41:31AM +0100, Tommy Sanddal Poulsen wrote:
> Hi,
> I'm currently working on a project implemented in C++ and having C interface
> functions declared in separate h-files. The header files are included inside
> extern "C" blocks, and this results in multiple define documentation blocks
> in the doxygen documentation for the h-file.
> 
> The three files file.h, fileA.cpp and fileB.cpp documented using a standard
> doxygen config file (although EXTRACT_ALL=YES) yields the peculiar result of
> three blocks documenting the define of the headerfile - I expected only one,
> as is the result when the #include's are not embedded inside an extern "C"
> block. 
> Does anyone have an idea of what to do ?

Doxygen's preprocessor includes header files verbatimly iff the #include
statement is found inside a curly block, to allow things like:

struct A {
#include "struct_A_elements.h"
};

to be parsed correctly (there is still the issue with line numbering in
the source browser which I have to address some day).

For extern "C" blocks this is of course not desired behaviour, so I'll
adapt the preprocessor for this case.

Regards,
  Dimitri