Skip to content

Commit 52e1c06

Browse files
author
Alexander Batashev
authored
[SYCL] Improve Doxygen documentation UX (#1201)
- Fix classes missing due to inline namespace macro. - Enable first sentence as brief. - Make diagrams clickable. Signed-off-by: Alexander Batashev <[email protected]>
1 parent 401d174 commit 52e1c06

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

sycl/doc/doxygen.cfg.in

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -187,15 +187,15 @@ SHORT_NAMES = NO
187187
# description.)
188188
# The default value is: NO.
189189

190-
JAVADOC_AUTOBRIEF = NO
190+
JAVADOC_AUTOBRIEF = YES
191191

192192
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
193193
# line (until the first dot) of a Qt-style comment as the brief description. If
194194
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
195195
# requiring an explicit \brief command for a brief description.)
196196
# The default value is: NO.
197197

198-
QT_AUTOBRIEF = NO
198+
QT_AUTOBRIEF = YES
199199

200200
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
201201
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
@@ -2061,15 +2061,15 @@ ENABLE_PREPROCESSING = YES
20612061
# The default value is: NO.
20622062
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
20632063

2064-
MACRO_EXPANSION = NO
2064+
MACRO_EXPANSION = YES
20652065

20662066
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
20672067
# the macro expansion is limited to the macros specified with the PREDEFINED and
20682068
# EXPAND_AS_DEFINED tags.
20692069
# The default value is: NO.
20702070
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
20712071

2072-
EXPAND_ONLY_PREDEF = NO
2072+
EXPAND_ONLY_PREDEF = YES
20732073

20742074
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
20752075
# INCLUDE_PATH will be searched if a #include is found.
@@ -2101,7 +2101,7 @@ INCLUDE_FILE_PATTERNS =
21012101
# recursively expanded use the := operator instead of the = operator.
21022102
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
21032103

2104-
PREDEFINED =
2104+
PREDEFINED = "__SYCL_INLINE_NAMESPACE(X)=namespace X"
21052105

21062106
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
21072107
# tag can be used to specify a list of macro names that should be expanded. The
@@ -2390,7 +2390,7 @@ DOT_IMAGE_FORMAT = @DOT_IMAGE_FORMAT@
23902390
# The default value is: NO.
23912391
# This tag requires that the tag HAVE_DOT is set to YES.
23922392

2393-
INTERACTIVE_SVG = NO
2393+
INTERACTIVE_SVG = YES
23942394

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

0 commit comments

Comments
 (0)