Skip to content
This repository was archived by the owner on Jul 25, 2022. It is now read-only.

Commit a3770cc

Browse files
committed
Configure doxygen documentation.
1 parent 4eeaff9 commit a3770cc

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ fp-lib-table
33
*.sch-bak
44
*.kicad_pcb-bak
55
/robot-control-src/wifi_ap.hpp
6+
doc/html

Doxyfile

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ PROJECT_LOGO =
5858
# entered, it will be relative to the location where doxygen was started. If
5959
# left blank the current directory will be used.
6060

61-
OUTPUT_DIRECTORY =
61+
OUTPUT_DIRECTORY = doc
6262

6363
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
6464
# directories (in 2 levels) under the output directory of each output format and
@@ -463,7 +463,7 @@ LOOKUP_CACHE_SIZE = 0
463463
# DOT_NUM_THREADS setting.
464464
# Minimum value: 0, maximum value: 32, default value: 1.
465465

466-
NUM_PROC_THREADS = 1
466+
NUM_PROC_THREADS = 0
467467

468468
#---------------------------------------------------------------------------
469469
# Build related configuration options
@@ -477,7 +477,7 @@ NUM_PROC_THREADS = 1
477477
# normally produced when WARNINGS is set to YES.
478478
# The default value is: NO.
479479

480-
EXTRACT_ALL = NO
480+
EXTRACT_ALL = YES
481481

482482
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
483483
# be included in the documentation.
@@ -951,7 +951,7 @@ FILE_PATTERNS = *.c \
951951
# be searched for input files as well.
952952
# The default value is: NO.
953953

954-
RECURSIVE = NO
954+
RECURSIVE = YES
955955

956956
# The EXCLUDE tag can be used to specify files and/or directories that should be
957957
# excluded from the INPUT source files. This way you can easily exclude a
@@ -1800,7 +1800,7 @@ EXTRA_SEARCH_MAPPINGS =
18001800
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
18011801
# The default value is: YES.
18021802

1803-
GENERATE_LATEX = YES
1803+
GENERATE_LATEX = NO
18041804

18051805
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
18061806
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -2336,7 +2336,7 @@ HIDE_UNDOC_RELATIONS = YES
23362336
# set to NO
23372337
# The default value is: NO.
23382338

2339-
HAVE_DOT = NO
2339+
HAVE_DOT = YES
23402340

23412341
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
23422342
# to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2402,7 +2402,7 @@ GROUP_GRAPHS = YES
24022402
# The default value is: NO.
24032403
# This tag requires that the tag HAVE_DOT is set to YES.
24042404

2405-
UML_LOOK = NO
2405+
UML_LOOK = YES
24062406

24072407
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
24082408
# class node. If there are many fields or methods and many nodes the graph may

0 commit comments

Comments
 (0)