Barnes, Peter D. via Doxygen-users wrote on 01.05.2020 at 00:23:
Hello Folks,
We want to document symbols which aren’t declared in the code, such as
environment variables and preprocessor symbols declared by the build system.
There doesn’t seem to be an easy way to do this.
For example, @var doesn’t generate output if the symbol doesn’t appear
somewhere in the code.
We could define nuisance string variables for the names of the
environment variables, but this wouldn’t work for preprocessor defines.
I can fake something that looks okay, using html tags, but there doesn’t
seem to be a way to make the symbol name appear in search results, so
that it’s easy to find.
Thanks for your help,
Peter
Dear Peter,
maybe it is too simple ...
You may consider to create a fake C, CPP, or H-file containing all
variables and defines you would like to define. You may even use another
extension like DOX. You would tell doxygen to parse this file and
document it as if it would belong to your code. But you would not
attempt to compile this file with your real compiler.
Clemens
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
