Fix doxygen generation #722
Conversation
|
|
||
| PROJECT_LOGO = | ||
| PROJECT_LOGO = @ROOTDIR@/exiv2.png |
There was a problem hiding this comment.
I'll highlight with comments the parts that I've changed during the update.
This is just to show the logo in every HTML page.
|
|
||
| MULTILINE_CPP_IS_BRIEF = NO | ||
| MULTILINE_CPP_IS_BRIEF = YES |
There was a problem hiding this comment.
I find this very useful for having one-liners of documentation treated as @brief without using the @brief keyword. For example:
/// My awesome function which does XXX
void awesome();
|
Would you mind cherry-picking or just including the change from 3e27828? That commit predefines the macro |
Codecov Report
@@ Coverage Diff @@
## master #722 +/- ##
=======================================
Coverage 69.54% 69.54%
=======================================
Files 143 143
Lines 18980 18980
=======================================
Hits 13200 13200
Misses 5780 5780Continue to review full report at Codecov.
|
This allows us to hide internal namespaces and some template magic which serves little purpose to have in the API documentation
This is far from perfect, but at least now when we enable the CMake option
EXIV2_BUILD_DOCwe can build thedoctarget to generate a decent Doxygen documentation.There is something which is still broken: the generation of the tags HTML pages. It seems that which the deletion of the autotools and makefiles we forgot to make the transition of this documentation building system to CMake. I'll create a new issue on Github to not forget about that.