Doxyfile: Exclude binary, CMake, libs, and test directories. #28
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
These directories do not contain any useful source files for the documentation of the internal API of AusweisApp2, and thus should not be included in its API documentation generated by Doxygen. Additionally this comes in handy for distributing the API documentation architecture independent, when the name of the binary directory contains the name of the system's architecture the build is targeted to. Also explicitly set the 'FULL_PATH_NAMES' parameter to 'YES', as this is needed for properly stripping and/or excluding the paths during generation of the documentation files. Signed-off-by: Björn Esser <[email protected]>
|
Sorry, for the delay. |
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.
These directories do not contain any useful source files for the documentation of the internal API of AusweisApp2, and thus should not be included in its API documentation generated by Doxygen.
Additionally this comes in handy for distributing the API documentation architecture independent, when the name of the binary directory contains the name of the system's architecture the build is targeted to.
Also explicitly set the 'FULL_PATH_NAMES' parameter to 'YES', as this is needed for properly stripping and/or excluding the paths during generation of the documentation files.
Signed-off-by: Björn Esser [email protected]