Preserve "$wxwin" verbatim in Doxygen output

It turns out that Doxygen expands $(VAR) into the actual value of the
VAR environment variable on the machine where it runs, which is
definitely not what we want in the instructions telling people to use
"$wxwin" in their projects, so remove the parentheses to prevent Doxygen
from expanding it.

Another alternative would be to escape "$" with a backslash, but this
would make the source markdown file uglier.
This commit is contained in:
Vadim Zeitlin
2019-06-24 02:37:46 +02:00
parent b383d539b5
commit a5d7f95877

View File

@@ -55,7 +55,7 @@ Next step is to set up your project to use these files. You need to do the
following: following:
* In the compiler options, i.e. "C/C++" properties: * In the compiler options, i.e. "C/C++" properties:
* Add `$(wxwin)/include/msvc;$(wxwin)/include` to the "Additional Include * Add `$wxwin/include/msvc;$wxwin/include` to the "Additional Include
Directories". Notice that the order is important here, putting the Directories". Notice that the order is important here, putting the
MSVC-specific directory first ensures that you use `wx/setup.h` MSVC-specific directory first ensures that you use `wx/setup.h`
automatically linking in wxWidgets libraries. automatically linking in wxWidgets libraries.
@@ -71,7 +71,7 @@ following:
* Check that you use "Multi-threaded \[Debug\] DLL" in the "Run-time * Check that you use "Multi-threaded \[Debug\] DLL" in the "Run-time
library" option under "Code Generation" to ensure that your build uses library" option under "Code Generation" to ensure that your build uses
the same CRT version as our binaries. the same CRT version as our binaries.
* In the linker options you only need to add `$(wxwin)\lib\vc141_dll` (with * In the linker options you only need to add `$wxwin\lib\vc141_dll` (with
the compiler-version-dependent suffix, of course) to "Additional Library the compiler-version-dependent suffix, of course) to "Additional Library
Directories" under "Linker\\General" in the options. Thanks to the use of Directories" under "Linker\\General" in the options. Thanks to the use of
MSVC-specific `setup.h` you don't need to list wxWidgets libraries manually, MSVC-specific `setup.h` you don't need to list wxWidgets libraries manually,