tumcms / Open-Infra-Platform

This is the official repository of the open-source Open Infra Platform software (as of April 2020).
Other
47 stars 21 forks source link

[BUG] GenerateDocumentation (Doxygen) is not included in the VS-project #535

Open christophKaiser opened 2 years ago

christophKaiser commented 2 years ago

Describe the bug After Configure and Generate by CMake with default settings from CMakeLists.txt, the project OpenInfraPlatform.GenerateDocumentation isn't included / visible in the folder Commands of Visual Studio.

To Reproduce Steps to reproduce the behavior:

  1. In CMake, delete cache
  2. Click Configure, Generate and Open Project in CMake
  3. Search in the Solution Explorer of Visual Studio (folder OpenInfraPlatform/Commands, project OpenInfraPlatform.GenerateDocumentation -> it won't be there)

Expected behavior The documentation "Doxygen for Open Infra Platform" states, that Doxygen will be enabled by default: https://github.com/tumcms/Open-Infra-Platform/blob/4fa2e0a4d39c42ae113ff4ba90e04e9b380d1ed3/Documentation/markdown/DoxygenHelp.md?plain=1#L24

However, Doxygen is disabled in the top-level CMakeLists.txt: https://github.com/tumcms/Open-Infra-Platform/blob/4fa2e0a4d39c42ae113ff4ba90e04e9b380d1ed3/CMakeLists.txt#L324

Of course, the user can switch on this option in CMake. But I don't know, if an unexperienced user would find this option. At least one file should be adjusted to be consistent.

Suggestion I found the commit, which has turned off the setting in the CMakesLists.txt. Unfortunately, to me it isn't obvious why it was turned off.

On my system, I tested the CMake build process today:

  1. Changed the above mentioned CMakeLists.txt to Option(DOXYGEN_GENERATE_DOCUMENTATION "Build documentation for TUM OpenInfraPlatform." ON)
  2. Deleted cache in CMake
  3. Clicked Configure, Generate and Open Project in CMake
  4. Built OpenInfraPlatform.GenerateDocumentation in Visual Studio
  5. The generated documentation opend automatically in a browser, like expected without noticeable side effects

If there is a background issue which is unknown to me, I would withdraw my suggestion.