doc: Build doxygen documentation #816
Open
+2,720
−0
Conversation
This file contains 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
The Doxygen documentation is generated and uploaded with GitHub actions. Currently the code is not yet thoroughly documented.
LukasWoodtli
force-pushed
the
gardena/lw/doxygen
branch
from
68c30f3
to
eb9004d
Compare
|
rettichschnidi
requested changes
Oct 24, 2024
| # YES. | ||
| # The default value is: system dependent. | ||
|
|
||
| CASE_SENSE_NAMES = NO |
There was a problem hiding this comment.
CI runs on Linux - should this be Yes or at least the default?
| # The default value is: png. | ||
| # This tag requires that the tag GENERATE_HTML is set to YES. | ||
|
|
||
| HTML_FORMULA_FORMAT = png |
There was a problem hiding this comment.
Suggested change
| HTML_FORMULA_FORMAT = png | |
| HTML_FORMULA_FORMAT = svg |
| # generate a warning when it encounters a \startuml command in this case and | ||
| # will not generate output for the diagram. | ||
|
|
||
| PLANTUML_JAR_PATH = |
There was a problem hiding this comment.
Would install platnuml via apt and enable support for it:
Suggested change
| PLANTUML_JAR_PATH = | |
| PLANTUML_JAR_PATH = /usr/share/plantuml/plantuml.jar |
| @@ -221,6 +223,11 @@ function run_tests() { | |||
| find "${REPO_ROOT_DIR}" -name \*.gcov -exec rm {} \; | |||
| } | |||
|
|
|||
| function run_doxygen() { | |||
| mkdir -p build-wakaama/doxygen_out | |||
| GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen_out \ | |||
There was a problem hiding this comment.
Would use either a dash, such as in build*-*wakaama:
Suggested change
| GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen_out \ | |
| GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen-out \ |
Or just leave out the _out part:
Suggested change
| GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen_out \ | |
| GIT_REVISION=$(git rev-parse @) WORKING_DIR=$(pwd) DOXYGEN_OUT_DIR=build-wakaama/doxygen \ |
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: Doxygen documentation (HTML) | ||
| path: build-wakaama/doxygen_out |
There was a problem hiding this comment.
Suggested change
| path: build-wakaama/doxygen_out | |
| path: build-wakaama/doxygen-out |
or
Suggested change
| path: build-wakaama/doxygen_out | |
| path: build-wakaama/doxygen |
(see other comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The Doxygen documentation is generated and uploaded with GitHub actions.
Currently the code is not yet thoroughly documented.