Skip to content

Commit ef0baaf

Browse files
authored
Doxygen: use MARKDOWN_ID_STYLE = GITHUB (#491)
This allows linking to subsections of a tutorial. Signed-off-by: Steve Peters <[email protected]>
1 parent e6097c5 commit ef0baaf

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/doxygen/api.in

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,17 @@ EXTENSION_MAPPING =
319319

320320
MARKDOWN_SUPPORT = YES
321321

322+
# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
323+
# generate identifiers for the Markdown headings.
324+
# Note: Every identifier is unique. Possible values are:
325+
# DOXYGEN use a fixed 'autotoc_md' string followed by a sequence number
326+
# starting at 0 and
327+
# GITHUB use the lower case version of title with any whitespace replaced by
328+
# '-' and punctuation characters removed.
329+
# The default value is: DOXYGEN.
330+
331+
MARKDOWN_ID_STYLE = GITHUB
332+
322333
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
323334
# to that level are automatically included in the table of contents, even if
324335
# they do not have an id attribute.

0 commit comments

Comments
 (0)