Skip to content

Doxygen Target Revival, master branch (2018.09.19.)

Attila Krasznahorkay requested to merge akraszna/atlasexternals:DoxygenRevival-master-20180917 into master

This is a shameless ripoff of @fwinkl's code from !104 (closed). I only made some minor tweaks to that one.

The idea is that any project that wants to be able to generate a Doxygen documentation, will be able to add a Doxyfile.in file into their source directory. In which they can rely in all of the "regular" CMake variables, and also the specially created SELECTED_PACKAGES variable.

For instance I created a file for athena/Projects/WorkDir that includes:

INPUT                  = @CMAKE_SOURCE_DIR@ @SELECTED_PACKAGES@
STRIP_FROM_PATH        = @CMAKE_SOURCE_DIR@
STRIP_FROM_INC_PATH    = @SELECTED_PACKAGES@

, which results in a surprisingly nice output. Like:

doxygen

I.e. the include path shows up correctly with such a setup!!!

We'll have to add separate Doxyfile.in files to all projects to use this, but I think that's a positive thing, as it will allow us to:

  • Create custom main pages for the projects;
  • Allow users to create custom looks for analysis repository documentations;
  • etc...

P.S. This is also to address ATLINFR-1843.

Merge request reports