After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 769679 - Feature Request: doxygen command to expand an environment variable
Feature Request: doxygen command to expand an environment variable
Status: RESOLVED OBSOLETE
Product: doxygen
Classification: Other
Component: general
1.8.11
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
[moved_to_github]
Depends on:
Blocks:
 
 
Reported: 2016-08-09 17:22 UTC by Marc Alff
Modified: 2018-07-30 10:54 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Marc Alff 2016-08-09 17:22:07 UTC
Currently, my @mainpage looks like:

...
Document generated on: ${DOXYGEN_GENERATION_DATE},
branch: ${DOXYGEN_GENERATION_BRANCH},
revision: ${DOXYGEN_GENERATION_REVISION}
...

Now, of course, doxygen does not know anything about DOXYGEN_GENERATION_DATE,
so my options are:
- use sed to substitute values in the source, before using doxygen (which is what is done currently),
- use sed in the generated output (ok for html, harder to do for pdf etc) to change values post generation.

The feature request is to have a new command, say @environment,
so the documentation can be written instead as:

...
Document generated on: @environment DOXYGEN_GENERATION_DATE,
branch: @environment DOXYGEN_GENERATION_BRANCH,
revision: @environment DOXYGEN_GENERATION_REVISION
...

Before invoking doxygen, the user build script is to export values, for example:
export MY_CUSTOM_THING=<my custom value here>

Doxygen, upon finding the tag @environment MY_CUSTOM_THING, is to execute a getenv("MY_CUSTOM_THING") and expand the result in the generated documentation.

Thanks for considering this request.
Comment 1 André Klapper 2018-07-30 10:54:11 UTC
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to 

   https://github.com/doxygen/doxygen/issues

All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github.

Hence I am closing this GNOME Bugzilla ticket.
Please use the corresponding ticket in Github instead. Thanks a lot!