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

Doxyfile: Exclude binary, CMake, libs, and test directories. #28

Merged
merged 1 commit into from
Oct 23, 2020
Merged

Doxyfile: Exclude binary, CMake, libs, and test directories. #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Doxyfile: Exclude binary, CMake, libs, and test directories. 
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]>
  • Loading branch information
@besser82
besser82 committed Aug 21, 2020
commit 7da59790e72ed2073a58f612772aa3fd18022f87
3 changes: 3 additions & 0 deletions Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ OPTIMIZE_OUTPUT_C = YES
QT_AUTOBRIEF = YES
BUILTIN_STL_SUPPORT = YES
GENERATE_TREEVIEW = YES
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@
EXCLUDE_PATTERNS = @PROJECT_BINARY_DIR@/* \
*/CMake* */libs/* */test/*

SEARCHENGINE = YES
COLS_IN_ALPHA_INDEX = 10
Expand Down