Skip to content

Commit 722d72a

Browse files
Fix doxyfile
1 parent 440a2bf commit 722d72a

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

doc/doxyfile.in

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
# TAG += value [value, ...]
1111
# Values that contain spaces should be placed between quotes (" ")
1212

13-
#-----------------------------------------------------input----------------------
13+
#---------------------------------------------------------------------------
1414
# Project related configuration options
1515
#---------------------------------------------------------------------------
1616

@@ -74,7 +74,7 @@ BRIEF_MEMBER_DESC = YES
7474
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
7575
# brief descriptions will be completely suppressed.
7676

77-
REPEAT_BRIEF = NO
77+
REPEAT_BRIEF = YES
7878

7979
# This tag implements a quasi-intelligent brief description abbreviator
8080
# that is used to form the text in various listings. Each string
@@ -170,7 +170,7 @@ SEPARATE_MEMBER_PAGES = NO
170170
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
171171
# Doxygen uses this value to replace tabs by spaces in code fragments.
172172

173-
TAB_SIZE = 4
173+
TAB_SIZE = 2
174174

175175
# This tag can be used to specify a number of aliases that acts
176176
# as commands in the documentation. An alias has the form "name=value".
@@ -574,11 +574,16 @@ WARN_LOGFILE =
574574
# directories like "/usr/src/myproject". Separate the files or directories
575575
# with spaces.
576576

577-
INPUT = "@PROJECT_SOURCE_DIR@/include" \
577+
INPUT = "@PROJECT_SOURCE_DIR@/README.md" \
578+
"@PROJECT_SOURCE_DIR@/include" \
578579
"@PROJECT_BINARY_DIR@/include" \
579580
"@PROJECT_SOURCE_DIR@/src" \
580581
"@PROJECT_SOURCE_DIR@/doc"
581582

583+
# We use the Markdown-formatted README as the main page.
584+
# Note that we don't give the full path here, but we do in the INPUT.
585+
USE_MDFILE_AS_MAINPAGE = "README.md"
586+
582587
# This tag can be used to specify the character encoding of the source files
583588
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
584589
# also the default input encoding. Doxygen uses libiconv (or the iconv built
@@ -634,7 +639,7 @@ EXCLUDE_SYMBOLS =
634639
# directories that contain example code fragments that are included (see
635640
# the \include command).
636641

637-
EXAMPLE_PATH =
642+
EXAMPLE_PATH = "@PROJECT_SOURCE_DIR@"
638643

639644
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
640645
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cxx
@@ -748,7 +753,7 @@ VERBATIM_HEADERS = YES
748753
# of all compounds will be generated. Enable this if the project
749754
# contains a lot of classes, structs, unions or interfaces.
750755

751-
ALPHABETICAL_INDEX = NO
756+
ALPHABETICAL_INDEX = YES
752757

753758
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
754759
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
@@ -1256,21 +1261,21 @@ PERLMOD_MAKEVAR_PREFIX =
12561261
# evaluate all C-preprocessor directives found in the sources and include
12571262
# files.
12581263

1264+
12591265
ENABLE_PREPROCESSING = YES
1266+
MACRO_EXPANSION = YES
1267+
EXPAND_ONLY_PREDEF = YES
1268+
PREDEFINED = __attribute__(x)=
12601269

12611270
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
12621271
# names in the source code. If set to NO (the default) only conditional
12631272
# compilation will be performed. Macro expansion can be done in a controlled
12641273
# way by setting EXPAND_ONLY_PREDEF to YES.
12651274

1266-
MACRO_EXPANSION = YES
1267-
12681275
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
12691276
# then the macro expansion is limited to the macros specified with the
12701277
# PREDEFINED and EXPAND_AS_DEFINED tags.
12711278

1272-
EXPAND_ONLY_PREDEF = NO
1273-
12741279
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
12751280
# in the INCLUDE_PATH (see below) will be search if a #include is found.
12761281

@@ -1297,8 +1302,6 @@ INCLUDE_FILE_PATTERNS =
12971302
# undefined via #undef or recursively expanded use the := operator
12981303
# instead of the = operator.
12991304

1300-
PREDEFINED =
1301-
13021305
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
13031306
# this tag can be used to specify a list of macro names that should be expanded.
13041307
# The macro definition that is found in the sources will be used.
@@ -1493,7 +1496,7 @@ DIRECTORY_GRAPH = YES
14931496
# generated by dot. Possible values are png, jpg, or gif
14941497
# If left blank png will be used.
14951498

1496-
DOT_IMAGE_FORMAT = jpg
1499+
DOT_IMAGE_FORMAT = png
14971500

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

0 commit comments

Comments
 (0)