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.

Sign up for GitHub

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

Jump to bottom

Found issue in doxygen generating documentation #5063

Closed
wenyikuang opened this issue Dec 19, 2023 · 0 comments · Fixed by #5078
Closed

Found issue in doxygen generating documentation #5063

wenyikuang opened this issue Dec 19, 2023 · 0 comments · Fixed by #5078
Assignees
@wenyikuang
Labels
Enhancement Request Triage Issue needs to be assessed and labeled, further information on reported might be needed

Comments

@wenyikuang
Copy link
Collaborator

wenyikuang commented Dec 19, 2023 •
edited
Loading

Righ now the 3.7.0 documentation is generated without line: https://github.com/NREL/OpenStudio/blob/develop/CMakeLists.txt#L1142

And we could notice the search bar is not working properly. May be due to

  • wrong Doxygen
  • Error in patch file

TODO:

  • Short term fix: require the 1.8.7 version of the Doxygent to generate the documentation properly.
  • Mid-term fix: update the corresponding Doxygen files (idf and CMakeList) and dependency to recent released version
  • Long-term fix: conver the mechanism of doc generating make it tracable.
@wenyikuang wenyikuang added Enhancement Request Triage Issue needs to be assessed and labeled, further information on reported might be needed labels Dec 19, 2023
@wenyikuang wenyikuang self-assigned this Dec 19, 2023
@wenyikuang wenyikuang mentioned this issue Dec 21, 2023
Merged
@jmarrec jmarrec mentioned this issue Jan 16, 2024
Merged
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wenyikuang wenyikuang

Labels
Enhancement Request Triage Issue needs to be assessed and labeled, further information on reported might be needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Properly set up CCACHE + fix doxygen config for versions up to 1.10.0 NREL/OpenStudio
1 participant
@wenyikuang