Doxygen: complete documentation for a project with C ++ and VHDL

Question

I am creating documentation for a library that consists of a C / C ++ part and a VHDL part, as well as some instructive pages for oxygen only. They should be placed in one autonomous group. Everything is still working, cute and fluffy ...

But what if I want to optimize the output in the vhdl subdirectory with OPTIMIZE_OUTPUT_VHDL = YES and optimize the output of the c subdirectory with OPTIMIZE_OUTPUT_C = YES at the same time?

As far as I understand, using doxygen-tags is not optimal in my case, since it introduces new doxyfile.conf files in each subdirectory with independent doxygen runs in each subdirectory. Thus, I cannot put both parts (c + vhdl) in different subgroups of the same group, and links between these two parts are impossible. In addition, the entire module must be “self-preserved” in order to be included in larger documents, without the special assembly structure involved in this decision ...

What would you do?

Answer 1

I had the same problem - in the end we did the following:

• Create another directory for the C code and the VHDL code (+ the corresponding doxygen user comment files - since we don’t want to spam the code using doxygen tags).
• Run Doxygen for each of these directories (each with its own oprimization tag - OPTIMIZE_OUTPUT_VHDL or OPTIMIZE_OUTPUT_C )
• Combine (manually !!! - although you can create a script for it) the output of these two directories, so that the main page will link to two directories.

In the end, I decided to reduce the time required to create the documentation, and I just ignore the optimization tags ...