diff options
| author | albert-github <albert.tests@gmail.com> | 2022-05-22 12:08:58 +0200 |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2022-05-22 12:08:58 +0200 |
| commit | f043cf8aaf676cc88e84082de49f70dd3492ecb0 (patch) | |
| tree | 8a058c89c41a9e84f5fe8c1c727a97e309fcd01e /src/Doxyfile.in | |
| parent | a163623da4e350f2e9de01144d74edfab1c28f78 (diff) | |
Documentation: handling references to examples in a more transparent way
In case we have the files`Bitmap_cubical_complex/Random_bitmap_cubical_complex.cpp` this will be linked to `_random_bitmap_cubical_complex_8cpp-example.html` and this is now hard coded.
When the setting of `CASE_SENSE_NAMES` is set to `YES` the mapping is to `Random_bitmap_cubical_complex_8cpp-example.html` but the hard coded link is still to `_random_bitmap_cubical_complex_8cpp-example.html` so the link cannot be resolved (at runtime!). Same could happen when the `CASE_SENSE_NAMES` is left blank and the the value is system dependent. It is unlikely that this happens but ...
By introducing the `ALIASES` `gudhi_example_link` this can be handled by doxygen in a more transparent way.
Furthermore wit 2 examples there was a double `cpp` in the text part, this has been corrected as well
Notre this solution supersedes #621 and maked #621 obsolete.
Diffstat (limited to 'src/Doxyfile.in')
| -rw-r--r-- | src/Doxyfile.in | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/Doxyfile.in b/src/Doxyfile.in index f76ba2bd..b15d47a6 100644 --- a/src/Doxyfile.in +++ b/src/Doxyfile.in @@ -229,7 +229,7 @@ TAB_SIZE = 2 # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. -ALIASES = +ALIASES = gudhi_example_link{2}="@ref \2 \"\1/\2\"" # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For |