Skip to content

Commit 96228f0

Browse files
committed
Adjust Doxygen settings; especially TYPEDEF_HIDES_STRUCT=NO
1 parent 2b928d0 commit 96228f0

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

Doxyfile

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ SHORT_NAMES = NO
195195
# description.)
196196
# The default value is: NO.
197197

198-
JAVADOC_AUTOBRIEF = NO
198+
JAVADOC_AUTOBRIEF = YES
199199

200200
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
201201
# such as
@@ -244,7 +244,7 @@ SEPARATE_MEMBER_PAGES = NO
244244
# uses this value to replace tabs by spaces in code fragments.
245245
# Minimum value: 1, maximum value: 16, default value: 4.
246246

247-
TAB_SIZE = 4
247+
TAB_SIZE = 8
248248

249249
# This tag can be used to specify a number of aliases that act as commands in
250250
# the documentation. An alias has the form:
@@ -434,7 +434,7 @@ INLINE_SIMPLE_STRUCTS = NO
434434
# types are typedef'ed and only the typedef is referenced, never the tag name.
435435
# The default value is: NO.
436436

437-
TYPEDEF_HIDES_STRUCT = YES
437+
TYPEDEF_HIDES_STRUCT = NO
438438

439439
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
440440
# cache is used to resolve symbols given their name and scope. Since this can be
@@ -485,7 +485,7 @@ EXTRACT_PACKAGE = NO
485485
# included in the documentation.
486486
# The default value is: NO.
487487

488-
EXTRACT_STATIC = YES
488+
EXTRACT_STATIC = NO
489489

490490
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
491491
# locally in source files will be included in the documentation. If set to NO,
@@ -518,7 +518,7 @@ EXTRACT_ANON_NSPACES = NO
518518
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
519519
# The default value is: NO.
520520

521-
HIDE_UNDOC_MEMBERS = NO
521+
HIDE_UNDOC_MEMBERS = YES
522522

523523
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
524524
# undocumented classes that are normally visible in the class hierarchy. If set
@@ -823,7 +823,7 @@ WARN_LOGFILE =
823823
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
824824
# Note: If this tag is empty the current directory is searched.
825825

826-
INPUT = . src src/lmic src/hal src/se/i src/se/drivers/default
826+
INPUT = . src src/lmic src/aes src/hal src/se/i src/se/drivers/default
827827

828828
# This tag can be used to specify the character encoding of the source files
829829
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1009,13 +1009,13 @@ STRIP_CODE_COMMENTS = YES
10091009
# entity all documented functions referencing it will be listed.
10101010
# The default value is: NO.
10111011

1012-
REFERENCED_BY_RELATION = NO
1012+
REFERENCED_BY_RELATION = YES
10131013

10141014
# If the REFERENCES_RELATION tag is set to YES then for each documented function
10151015
# all documented entities called/used by that function will be listed.
10161016
# The default value is: NO.
10171017

1018-
REFERENCES_RELATION = NO
1018+
REFERENCES_RELATION = YES
10191019

10201020
# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
10211021
# to YES then the hyperlinks from functions in REFERENCES_RELATION and
@@ -1246,7 +1246,7 @@ HTML_COLORSTYLE_GAMMA = 80
12461246
# The default value is: NO.
12471247
# This tag requires that the tag GENERATE_HTML is set to YES.
12481248

1249-
HTML_TIMESTAMP = NO
1249+
HTML_TIMESTAMP = YES
12501250

12511251
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
12521252
# documentation will contain a main index with vertical navigation menus that
@@ -1265,7 +1265,7 @@ HTML_DYNAMIC_MENUS = YES
12651265
# The default value is: NO.
12661266
# This tag requires that the tag GENERATE_HTML is set to YES.
12671267

1268-
HTML_DYNAMIC_SECTIONS = NO
1268+
HTML_DYNAMIC_SECTIONS = YES
12691269

12701270
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
12711271
# shown in the various tree structured indices initially; the user can expand
@@ -1292,15 +1292,15 @@ HTML_INDEX_NUM_ENTRIES = 100
12921292
# The default value is: NO.
12931293
# This tag requires that the tag GENERATE_HTML is set to YES.
12941294

1295-
GENERATE_DOCSET = NO
1295+
GENERATE_DOCSET = YES
12961296

12971297
# This tag determines the name of the docset feed. A documentation feed provides
12981298
# an umbrella under which multiple documentation sets from a single provider
12991299
# (such as a company or product suite) can be grouped.
13001300
# The default value is: Doxygen generated docs.
13011301
# This tag requires that the tag GENERATE_DOCSET is set to YES.
13021302

1303-
DOCSET_FEEDNAME = "Doxygen generated docs"
1303+
DOCSET_FEEDNAME = "Arduio LMIC docs"
13041304

13051305
# This tag specifies a string that should uniquely identify the documentation
13061306
# set bundle. This should be a reverse domain-name style string, e.g.
@@ -1407,7 +1407,7 @@ QCH_FILE =
14071407
# The default value is: org.doxygen.Project.
14081408
# This tag requires that the tag GENERATE_QHP is set to YES.
14091409

1410-
QHP_NAMESPACE = org.doxygen.Project
1410+
QHP_NAMESPACE = com.mcci.catena.arduino-lmic
14111411

14121412
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
14131413
# Help Project output. For more information please see Qt Help Project / Virtual
@@ -1494,7 +1494,7 @@ DISABLE_INDEX = NO
14941494
# The default value is: NO.
14951495
# This tag requires that the tag GENERATE_HTML is set to YES.
14961496

1497-
GENERATE_TREEVIEW = NO
1497+
GENERATE_TREEVIEW = YES
14981498

14991499
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
15001500
# doxygen will group on one line in the generated HTML documentation.

0 commit comments

Comments
 (0)