Doxygen configuration and fix examples for better documentation#124
Merged
dietmarkuehl merged 3 commits intobemanproject:mainfrom Jan 23, 2025
Andres-Salamanca:main
Merged
Doxygen configuration and fix examples for better documentation#124dietmarkuehl merged 3 commits intobemanproject:mainfrom Andres-Salamanca:main
dietmarkuehl merged 3 commits intobemanproject:mainfrom
Andres-Salamanca:main
Conversation
…examples.md to ensure proper syntax highlighting for C++ code.
…e use of the \include special command in Doxygen. This allows example files, such as intro-1-hello-world.cpp, to be correctly referenced and displayed in the documentation.
Andres-Salamanca
requested review from
camio,
dietmarkuehl and
neatudarius
as code owners
dietmarkuehl
approved these changes
Jan 23, 2025
Member
dietmarkuehl
left a comment
dietmarkuehl
left a comment
There was a problem hiding this comment.
Nice! I'm new to doxygen: these help to get better examples!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated Doxygen fenced code blocks in /intro-examples.md from c++ -> cpp for proper syntax highlighting.
Added EXAMPLE_PATH = examples/ to the Doxyfile, enabling the \include special command in Doxygen.
This ensures example files (e.g. intro-1-hello-world.cpp) are correctly displayed in the generated documentation.