Skip to content

Commit 375345a

Browse files
authored
Remove back-tick that was breaking CMake doxygen docs (#1140)
Related to #1138 Added "docs/html/*" to .gitignore so Doxygen output does not get checked in.
1 parent 8633971 commit 375345a

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ libtool
1919
portaudio-2.0.pc
2020
autom4te.cache/*
2121

22+
# Doxygen output
23+
doc/html/*
24+
2225
# Precompiled Headers
2326
*.gch
2427
*.pch

doc/src/tutorial/compile_cmake.dox

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ On Windows and macOS, PortAudio does not need any additional dependencies. On ot
2323

2424
We will follow three steps to build PortAudio:
2525

26-
- @ref compile_cmake_general_clone
26+
- @ref compile_cmake_general_clone
2727
- @ref compile_cmake_general_configure
2828
- @ref compile_cmake_general_build
2929

@@ -155,7 +155,7 @@ And, finally, the Windows equivalent:
155155

156156
PortAudio's CMake build system also features several configuration options. For a list of options, see @ref compile_cmake_options. Append them to your configure command in the format `-DOPTION_NAME=VALUE`, with `VALUE` usually being either `ON` or `OFF`. For example, `cmake /path/to/portaudio -DPA_BUILD_TESTS=ON`. Note that you should not need to restart with a fresh, empty build directory each time you change a config option, but if you encounter problems, then you should start with a fresh build directory and try again.
157157

158-
If you want to use a different build file generator, add `-G "Generator Name"` to the initial configuration `cmake` command, where "Generator Name"` names the generator that you want to use, for example "Ninja". We will only cover the default generators (Visual Studio projects and Unix Makefiles) here, but if you are experienced with other generators, you are free to use them. The command `cmake --help` lists all available build file generators.
158+
If you want to use a different build file generator, add `-G "Generator Name"` to the initial configuration `cmake` command, where "Generator Name" names the generator that you want to use, for example "Ninja". We will only cover the default generators (Visual Studio projects and Unix Makefiles) here, but if you are experienced with other generators, you are free to use them. The command `cmake --help` lists all available build file generators.
159159

160160
The following sections give platform-specific examples. Note that these examples assume that you have created a build directory outside the source tree named `pabuild`.
161161

0 commit comments

Comments
 (0)