Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow preventing unwanted environment variable expansion in Markdown ... blocks #7073

Open
vadz opened this issue Jun 24, 2019 · 2 comments
Open

Comments

@vadz
Copy link

vadz commented Jun 24, 2019

Currently writing something like this:

To use the library, you need to add `-I$(WXWIN)/include` to the compiler options.

results in -I/include in the output because the environment variable gets expanded when Doxygen is run. While I realize that this is done intentionally and it may be useful to do it in other situations, it's definitely not wanted here and I'm not sure if it's ever really desirable to do it inside Markdown backticks.

So I think Doxygen shouldn't expand environment variables inside backticks by default or, if you think it should, should at least provide some way of disabling it.

Currently the least bad workaround I have is to use

`-I$``(WXWIN)/include`

which is just ugly.

Reference to (old) stack overflow question: https://stackoverflow.com/questions/18499009/doxygen-expands-environment-variable-inside-mainpage

@albert-github
Copy link
Collaborator

albert-github commented Jun 24, 2019

An less ugly approach might be to escape the $ sign and use the ´\c´:

\c \$(VAR)/dir

@vadz
Copy link
Author

vadz commented Jun 24, 2019

Thanks, using \c is indeed better than using <code>, but still looks rather out of place in Markdown files -- notably it's not highlighted as code in the editor by default.

smcv added a commit to smcv/SDL that referenced this issue Nov 30, 2021
Otherwise, the API documentation will encode the home directory of the
user or autobuilder that built SDL, instead of telling the user to use
the literal string $(HOME) as intended.

See also <doxygen/doxygen#7073>.

Signed-off-by: Simon McVittie <smcv@debian.org>
sezero pushed a commit to libsdl-org/SDL that referenced this issue Nov 30, 2021
Otherwise, the API documentation will encode the home directory of the
user or autobuilder that built SDL, instead of telling the user to use
the literal string $(HOME) as intended.

See also <doxygen/doxygen#7073>.

Signed-off-by: Simon McVittie <smcv@debian.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants