Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
christophKaiser opened this issue Apr 8, 2022 · 0 comments · May be fixed by #536
Open

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

christophKaiser opened this issue Apr 8, 2022 · 0 comments · May be fixed by #536
Assignees
Labels
bug Something isn't working build_process Problems in build process (CMake etc.) documentation Improvements or additions to documentation

Comments

@christophKaiser
Copy link
Collaborator

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:

If `DOXYGEN_GENERATE_DOCUMENTATION` is checked in the CMake GUI (default = ON), CMake will try to find the doxygen and dot executables in `C/thirdparty`. Additionally, a command that builds the documentation will be added to the solution.

However, Doxygen is disabled in the top-level CMakeLists.txt:

Option(DOXYGEN_GENERATE_DOCUMENTATION "Build documentation for TUM OpenInfraPlatform." OFF)

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.

@christophKaiser christophKaiser added the bug Something isn't working label Apr 8, 2022
@christophKaiser christophKaiser self-assigned this Apr 8, 2022
@christophKaiser christophKaiser added documentation Improvements or additions to documentation build_process Problems in build process (CMake etc.) labels Apr 8, 2022
@christophKaiser christophKaiser linked a pull request Apr 8, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working build_process Problems in build process (CMake etc.) documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant