Blob Blame History Raw
From 7da59790e72ed2073a58f612772aa3fd18022f87 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Esser?= <besser82@fedoraproject.org>
Date: Fri, 21 Aug 2020 12:42:43 +0200
Subject: [PATCH] Doxyfile: Exclude binary, CMake, libs, and test directories.
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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 <besser82@fedoraproject.org>
---
 Doxyfile.in | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Doxyfile.in b/Doxyfile.in
index 7c4633f..2242bff 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -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