tags:

views:

14

answers:

0

Hi,

My company develops a primarily C-based API, using IDLs to define the interfaces and generate the C headers. We'd like to use Doxygen to document the interfaces in the IDLs, but we'd also like the API reference to document the C headers. In other words, the fact that we are using IDLs should be transparent to the customers of our APIs.

Our IDL compiler will migrate the comment blocks from the IDL to the C headers, and we could then run Doxygen on the generated headers, but this would result in a loss of the interface structure defined in the IDLs (the interface methods in C are just static functions).

We could also have the IDL compiler add tags to the documentation blocks in order to preserve the structure, but that would tangle up the IDL compiler with our current choice of documentation engine and we'd like to avoid that.

Has anyone tried solving this type of problem in the past? Any suggestions?