Skip to content

Commit d7f796d

Browse files
Updated the Doxyfile to include EXAMPLE_PATH = examples/, enabling the use of the \include special command in Doxygen. This allows example files, such as intro-1-hello-world.cpp, to be correctly referenced and displayed in the documentation.
1 parent ec93e1d commit d7f796d

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -986,7 +986,7 @@ EXCLUDE_SYMBOLS = beman::*::detail, beman::*::detail::*
986986
# that contain example code fragments that are included (see the \include
987987
# command).
988988

989-
EXAMPLE_PATH =
989+
EXAMPLE_PATH = examples/
990990

991991
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
992992
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and

docs/intro-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This page provides a series of examples showing how to use the
88
<details>
99
<summary>`"Hello, world"` - synchronous using asynchronous components</summary>
1010

11-
Code: [`examples/intro-1-hello-world.cpp`]()
11+
@include examples/intro-1-hello-world.cpp
1212

1313
The first example is a very complicated way to a version of `"Hello,
1414
world"`: it uses components for dealing with asynchronous work to

0 commit comments

Comments
 (0)