Skip to content

Commit ae13b7b

Browse files
committed
Change the layout of the doxygen-generated documentation
* Move from index-based layout to treeview-based one. * Automatically take the first sentence of the documentation as the brief doc. * Always generate both brief and detailed description sections, and always sort them alpabetically. * Disable the generation of huge and overly complex call and caller graphs. * Make the project title title-cased. JerryScript-DCO-1.0-Signed-off-by: Akos Kiss [email protected]
1 parent 0d7ea70 commit ae13b7b

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Doxyfile

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ 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 = "JavaScript engine for Internet of Things"
47+
PROJECT_BRIEF = "JavaScript Engine for Internet of Things"
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
@@ -125,7 +125,7 @@ ABBREVIATE_BRIEF =
125125
# description.
126126
# The default value is: NO.
127127

128-
ALWAYS_DETAILED_SEC = NO
128+
ALWAYS_DETAILED_SEC = YES
129129

130130
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
131131
# inherited members of a class in the documentation of that class as if those
@@ -177,7 +177,7 @@ SHORT_NAMES = NO
177177
# description.)
178178
# The default value is: NO.
179179

180-
JAVADOC_AUTOBRIEF = NO
180+
JAVADOC_AUTOBRIEF = YES
181181

182182
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
183183
# line (until the first dot) of a Qt-style comment as the brief description. If
@@ -552,7 +552,7 @@ SORT_MEMBER_DOCS = YES
552552
# this will also influence the order of the classes in the class list.
553553
# The default value is: NO.
554554

555-
SORT_BRIEF_DOCS = NO
555+
SORT_BRIEF_DOCS = YES
556556

557557
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
558558
# (brief and detailed) documentation of class members so that constructors and
@@ -1161,7 +1161,7 @@ HTML_TIMESTAMP = NO
11611161
# The default value is: NO.
11621162
# This tag requires that the tag GENERATE_HTML is set to YES.
11631163

1164-
HTML_DYNAMIC_SECTIONS = NO
1164+
HTML_DYNAMIC_SECTIONS = YES
11651165

11661166
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
11671167
# shown in the various tree structured indices initially; the user can expand
@@ -1373,7 +1373,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
13731373
# The default value is: NO.
13741374
# This tag requires that the tag GENERATE_HTML is set to YES.
13751375

1376-
DISABLE_INDEX = NO
1376+
DISABLE_INDEX = YES
13771377

13781378
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
13791379
# structure should be generated to display hierarchical information. If the tag
@@ -1390,7 +1390,7 @@ DISABLE_INDEX = NO
13901390
# The default value is: NO.
13911391
# This tag requires that the tag GENERATE_HTML is set to YES.
13921392

1393-
GENERATE_TREEVIEW = NO
1393+
GENERATE_TREEVIEW = YES
13941394

13951395
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
13961396
# doxygen will group on one line in the generated HTML documentation.
@@ -2115,7 +2115,7 @@ HIDE_UNDOC_RELATIONS = YES
21152115
# set to NO
21162116
# The default value is: YES.
21172117

2118-
HAVE_DOT = YES
2118+
HAVE_DOT = NO
21192119

21202120
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
21212121
# to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2231,7 +2231,7 @@ INCLUDED_BY_GRAPH = YES
22312231
# The default value is: NO.
22322232
# This tag requires that the tag HAVE_DOT is set to YES.
22332233

2234-
CALL_GRAPH = YES
2234+
CALL_GRAPH = NO
22352235

22362236
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
22372237
# dependency graph for every global function or class method.
@@ -2242,7 +2242,7 @@ CALL_GRAPH = YES
22422242
# The default value is: NO.
22432243
# This tag requires that the tag HAVE_DOT is set to YES.
22442244

2245-
CALLER_GRAPH = YES
2245+
CALLER_GRAPH = NO
22462246

22472247
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
22482248
# hierarchy of all classes instead of a textual one.
@@ -2283,7 +2283,7 @@ DOT_IMAGE_FORMAT = png
22832283
# The default value is: NO.
22842284
# This tag requires that the tag HAVE_DOT is set to YES.
22852285

2286-
INTERACTIVE_SVG = YES
2286+
INTERACTIVE_SVG = NO
22872287

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

0 commit comments

Comments
 (0)