Skip to content

Commit

Permalink
[Docs] update Doxygen STRIP_FROM_*PATH
Browse files Browse the repository at this point in the history
  • Loading branch information
tttapa committed Aug 29, 2023
1 parent f2b5f03 commit e0d6023
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions doxygen/Doxyfile.common
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ INLINE_INHERITED_MEMB = YES
# shortest path that makes the file name unique will be used
# The default value is: YES.

FULL_PATH_NAMES = NO
FULL_PATH_NAMES = YES

# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
Expand All @@ -174,8 +174,7 @@ FULL_PATH_NAMES = NO
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.

STRIP_FROM_PATH = ../src \
../src/include
STRIP_FROM_PATH = ..

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
Expand All @@ -184,8 +183,15 @@ STRIP_FROM_PATH = ../src \
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.

STRIP_FROM_INC_PATH = ../src \
../src/include
STRIP_FROM_INC_PATH = ../src/alpaqa/include \
../src/interop/casadi/include \
../src/interop/dl-api/include \
../src/interop/dl/include \
../src/interop/lbfgspp/include \
../src/interop/lbfgsb/include \
../src/interop/ipopt/include \
../src/interop/qpalm/include \
../src/interop/cutest/include

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
Expand Down Expand Up @@ -2324,9 +2330,11 @@ INCLUDE_PATH = ../src/alpaqa/include \
../src/interop/casadi/include \
../src/interop/dl-api/include \
../src/interop/dl/include \
../src/interop/ipopt/include \
../src/interop/lbfgspp/include \
../src/interop/lbfgsb/include
../src/interop/lbfgsb/include \
../src/interop/ipopt/include \
../src/interop/qpalm/include \
../src/interop/cutest/include

# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
Expand Down Expand Up @@ -2657,7 +2665,7 @@ DOT_IMAGE_FORMAT = svg
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.

INTERACTIVE_SVG = NO
INTERACTIVE_SVG = YES

# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
Expand Down

0 comments on commit e0d6023

Please sign in to comment.