Skip to content

Commit fa2ccf5

Browse files
committed
doxygen: update configurations
These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. Signed-off-by: Chen Wang <[email protected]>
1 parent f03b745 commit fa2ccf5

File tree

1 file changed

+34
-72
lines changed

1 file changed

+34
-72
lines changed

documentation/Doxyfile

Lines changed: 34 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "My Project"
35+
PROJECT_NAME = "RT-Thread RTOS"
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
@@ -44,14 +44,14 @@ PROJECT_NUMBER =
4444
# for a project that appears at the top of each page and should give viewer a
4545
# quick idea about the purpose of the project. Keep the description short.
4646

47-
PROJECT_BRIEF =
47+
PROJECT_BRIEF = "An open source embedded real-time operating system"
4848

4949
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
5050
# in the documentation. The maximum height of the logo should not exceed 55
5151
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
5252
# the logo to the output directory.
5353

54-
PROJECT_LOGO =
54+
PROJECT_LOGO = ./0.doxygen/images/rtthread_logo.png
5555

5656
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
5757
# into which the generated documentation will be written. If a relative path is
@@ -106,7 +106,7 @@ OUTPUT_TEXT_DIRECTION = None
106106
# documentation (similar to Javadoc). Set to NO to disable this.
107107
# The default value is: YES.
108108

109-
BRIEF_MEMBER_DESC = YES
109+
BRIEF_MEMBER_DESC = NO
110110

111111
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
112112
# description of a member or function before the detailed description
@@ -143,7 +143,7 @@ ABBREVIATE_BRIEF = "The $name class" \
143143
# description.
144144
# The default value is: NO.
145145

146-
ALWAYS_DETAILED_SEC = NO
146+
ALWAYS_DETAILED_SEC = YES
147147

148148
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149149
# inherited members of a class in the documentation of that class as if those
@@ -277,7 +277,7 @@ ALIASES =
277277
# members will be omitted, etc.
278278
# The default value is: NO.
279279

280-
OPTIMIZE_OUTPUT_FOR_C = NO
280+
OPTIMIZE_OUTPUT_FOR_C = YES
281281

282282
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
283283
# Python sources only. Doxygen will then generate output that is more tailored
@@ -517,7 +517,7 @@ EXTRACT_STATIC = NO
517517
# for Java sources.
518518
# The default value is: YES.
519519

520-
EXTRACT_LOCAL_CLASSES = YES
520+
EXTRACT_LOCAL_CLASSES = NO
521521

522522
# This flag is only useful for Objective-C code. If set to YES, local methods,
523523
# which are defined in the implementation section but not in the interface are
@@ -549,15 +549,15 @@ RESOLVE_UNNAMED_PARAMS = YES
549549
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
550550
# The default value is: NO.
551551

552-
HIDE_UNDOC_MEMBERS = NO
552+
HIDE_UNDOC_MEMBERS = YES
553553

554554
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
555555
# undocumented classes that are normally visible in the class hierarchy. If set
556556
# to NO, these classes will be included in the various overviews. This option
557557
# has no effect if EXTRACT_ALL is enabled.
558558
# The default value is: NO.
559559

560-
HIDE_UNDOC_CLASSES = NO
560+
HIDE_UNDOC_CLASSES = YES
561561

562562
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
563563
# declarations. If set to NO, these declarations will be included in the
@@ -594,7 +594,7 @@ INTERNAL_DOCS = NO
594594
# YES.
595595
# The default value is: system dependent.
596596

597-
CASE_SENSE_NAMES = YES
597+
CASE_SENSE_NAMES = NO
598598

599599
# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
600600
# their full class and namespace scopes in the documentation. If set to YES, the
@@ -640,7 +640,7 @@ INLINE_INFO = YES
640640
# name. If set to NO, the members will appear in declaration order.
641641
# The default value is: YES.
642642

643-
SORT_MEMBER_DOCS = YES
643+
SORT_MEMBER_DOCS = NO
644644

645645
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
646646
# descriptions of file, namespace and class members alphabetically by member
@@ -660,7 +660,7 @@ SORT_BRIEF_DOCS = NO
660660
# detailed member documentation.
661661
# The default value is: NO.
662662

663-
SORT_MEMBERS_CTORS_1ST = NO
663+
SORT_MEMBERS_CTORS_1ST = YES
664664

665665
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
666666
# of group names into alphabetical order. If set to NO the group names will
@@ -677,7 +677,7 @@ SORT_GROUP_NAMES = NO
677677
# list.
678678
# The default value is: NO.
679679

680-
SORT_BY_SCOPE_NAME = NO
680+
SORT_BY_SCOPE_NAME = YES
681681

682682
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
683683
# type resolution of all parameters of a function it will reject a match between
@@ -693,13 +693,13 @@ STRICT_PROTO_MATCHING = NO
693693
# list. This list is created by putting \todo commands in the documentation.
694694
# The default value is: YES.
695695

696-
GENERATE_TODOLIST = YES
696+
GENERATE_TODOLIST = NO
697697

698698
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
699699
# list. This list is created by putting \test commands in the documentation.
700700
# The default value is: YES.
701701

702-
GENERATE_TESTLIST = YES
702+
GENERATE_TESTLIST = NO
703703

704704
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
705705
# list. This list is created by putting \bug commands in the documentation.
@@ -736,7 +736,7 @@ MAX_INITIALIZER_LINES = 30
736736
# list will mention the files that were used to generate the documentation.
737737
# The default value is: YES.
738738

739-
SHOW_USED_FILES = YES
739+
SHOW_USED_FILES = NO
740740

741741
# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
742742
# will remove the Files entry from the Quick Index and from the Folder Tree View
@@ -836,7 +836,7 @@ WARN_NO_PARAMDOC = NO
836836
# Possible values are: NO, YES and FAIL_ON_WARNINGS.
837837
# The default value is: NO.
838838

839-
WARN_AS_ERROR = NO
839+
WARN_AS_ERROR = FAIL_ON_WARNINGS
840840

841841
# The WARN_FORMAT tag determines the format of the warning messages that doxygen
842842
# can produce. The string should contain the $file, $line, and $text tags, which
@@ -864,7 +864,7 @@ WARN_LOGFILE =
864864
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
865865
# Note: If this tag is empty the current directory is searched.
866866

867-
INPUT =
867+
INPUT = .
868868

869869
# This tag can be used to specify the character encoding of the source files
870870
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -895,55 +895,16 @@ INPUT_ENCODING = UTF-8
895895

896896
FILE_PATTERNS = *.c \
897897
*.cc \
898-
*.cxx \
899898
*.cpp \
900-
*.c++ \
901-
*.java \
902-
*.ii \
903-
*.ixx \
904-
*.ipp \
905-
*.i++ \
906-
*.inl \
907-
*.idl \
908-
*.ddl \
909-
*.odl \
910899
*.h \
911-
*.hh \
912-
*.hxx \
913-
*.hpp \
914-
*.h++ \
915-
*.cs \
916-
*.d \
917-
*.php \
918-
*.php4 \
919-
*.php5 \
920-
*.phtml \
921900
*.inc \
922-
*.m \
923-
*.markdown \
924-
*.md \
925-
*.mm \
926-
*.dox \
927-
*.py \
928-
*.pyw \
929-
*.f90 \
930-
*.f95 \
931-
*.f03 \
932-
*.f08 \
933-
*.f18 \
934-
*.f \
935-
*.for \
936-
*.vhd \
937-
*.vhdl \
938-
*.ucf \
939-
*.qsf \
940-
*.ice
901+
*.md
941902

942903
# The RECURSIVE tag can be used to specify whether or not subdirectories should
943904
# be searched for input files as well.
944905
# The default value is: NO.
945906

946-
RECURSIVE = NO
907+
RECURSIVE = YES
947908

948909
# The EXCLUDE tag can be used to specify files and/or directories that should be
949910
# excluded from the INPUT source files. This way you can easily exclude a
@@ -952,7 +913,8 @@ RECURSIVE = NO
952913
# Note that relative paths are relative to the directory from which doxygen is
953914
# run.
954915

955-
EXCLUDE =
916+
EXCLUDE = ./0.doxygen/mainpage.h \
917+
./README.md
956918

957919
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
958920
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -1005,7 +967,7 @@ EXAMPLE_RECURSIVE = NO
1005967
# that contain images that are to be included in the documentation (see the
1006968
# \image command).
1007969

1008-
IMAGE_PATH =
970+
IMAGE_PATH = .
1009971

1010972
# The INPUT_FILTER tag can be used to specify a program that doxygen should
1011973
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1147,7 +1109,7 @@ USE_HTAGS = NO
11471109
# See also: Section \class.
11481110
# The default value is: YES.
11491111

1150-
VERBATIM_HEADERS = YES
1112+
VERBATIM_HEADERS = NO
11511113

11521114
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
11531115
# clang parser (see:
@@ -1196,7 +1158,7 @@ CLANG_DATABASE_PATH =
11961158
# classes, structs, unions or interfaces.
11971159
# The default value is: YES.
11981160

1199-
ALPHABETICAL_INDEX = YES
1161+
ALPHABETICAL_INDEX = NO
12001162

12011163
# In case all classes in a project start with a common prefix, all classes will
12021164
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
@@ -1332,7 +1294,7 @@ HTML_COLORSTYLE_GAMMA = 80
13321294
# The default value is: NO.
13331295
# This tag requires that the tag GENERATE_HTML is set to YES.
13341296

1335-
HTML_TIMESTAMP = NO
1297+
HTML_TIMESTAMP = YES
13361298

13371299
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
13381300
# documentation will contain a main index with vertical navigation menus that
@@ -1351,7 +1313,7 @@ HTML_DYNAMIC_MENUS = YES
13511313
# The default value is: NO.
13521314
# This tag requires that the tag GENERATE_HTML is set to YES.
13531315

1354-
HTML_DYNAMIC_SECTIONS = NO
1316+
HTML_DYNAMIC_SECTIONS = YES
13551317

13561318
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
13571319
# shown in the various tree structured indices initially; the user can expand
@@ -1546,15 +1508,15 @@ QHG_LOCATION =
15461508
# The default value is: NO.
15471509
# This tag requires that the tag GENERATE_HTML is set to YES.
15481510

1549-
GENERATE_ECLIPSEHELP = NO
1511+
GENERATE_ECLIPSEHELP = YES
15501512

15511513
# A unique identifier for the Eclipse help plugin. When installing the plugin
15521514
# the directory name containing the HTML and XML files should also have this
15531515
# name. Each documentation set should have its own identifier.
15541516
# The default value is: org.doxygen.Project.
15551517
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
15561518

1557-
ECLIPSE_DOC_ID = org.doxygen.Project
1519+
ECLIPSE_DOC_ID = org.rt-thread.api_help
15581520

15591521
# If you want full control over the layout of the generated HTML pages it might
15601522
# be necessary to disable the index and replace it with your own. The
@@ -1582,7 +1544,7 @@ DISABLE_INDEX = NO
15821544
# The default value is: NO.
15831545
# This tag requires that the tag GENERATE_HTML is set to YES.
15841546

1585-
GENERATE_TREEVIEW = NO
1547+
GENERATE_TREEVIEW = YES
15861548

15871549
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
15881550
# doxygen will group on one line in the generated HTML documentation.
@@ -1790,7 +1752,7 @@ EXTRA_SEARCH_MAPPINGS =
17901752
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
17911753
# The default value is: YES.
17921754

1793-
GENERATE_LATEX = YES
1755+
GENERATE_LATEX = NO
17941756

17951757
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
17961758
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -2405,7 +2367,7 @@ CLASS_GRAPH = YES
24052367
# The default value is: YES.
24062368
# This tag requires that the tag HAVE_DOT is set to YES.
24072369

2408-
COLLABORATION_GRAPH = YES
2370+
COLLABORATION_GRAPH = NO
24092371

24102372
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
24112373
# groups, showing the direct groups dependencies.
@@ -2420,7 +2382,7 @@ GROUP_GRAPHS = YES
24202382
# The default value is: NO.
24212383
# This tag requires that the tag HAVE_DOT is set to YES.
24222384

2423-
UML_LOOK = NO
2385+
UML_LOOK = YES
24242386

24252387
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
24262388
# class node. If there are many fields or methods and many nodes the graph may
@@ -2617,7 +2579,7 @@ DOT_GRAPH_MAX_NODES = 50
26172579
# Minimum value: 0, maximum value: 1000, default value: 0.
26182580
# This tag requires that the tag HAVE_DOT is set to YES.
26192581

2620-
MAX_DOT_GRAPH_DEPTH = 0
2582+
MAX_DOT_GRAPH_DEPTH = 1000
26212583

26222584
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
26232585
# background. This is disabled by default, because dot on Windows does not seem

0 commit comments

Comments
 (0)