Age | Commit message (Collapse) | Author |
|
Documentation: Render formulas by means of MathJax 3
|
|
Based on review, made a switch between MathJax 2 and MathJax 3 based on the doxygen version
|
|
- create entries in Doxyfile.in for the use of MathJax
- adjust formula so it is properly rendered in MathJax 3 (formula will also work with MathJax 2)
(available in doxygen since doxygen 1.9.2)
|
|
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.
|
|
Based on review corrected `EXAMPLE_PATH` and `CITE_BIB_FILES`.
|
|
When running doxygen on the sources we get (a.o.) the following warnings:
```
.../gudhi-devel/src/Contraction/include/gudhi/Edge_contraction.h:214: warning: unbalanced grouping commands
.../gudhi-devel/src/common/doc/examples.h:3: warning: the name 'Examples' supplied as the argument in the \file statement is not an input file
error: bib file .../gudhi-devel/biblio/how_to_cite_gudhi.bib not found!
.../gudhi-devel/src/common/doc/installation.h:271: warning: included file biblio/how_to_cite_gudhi.bib is not found. Check your EXAMPLE_PATH
```
This is corrected in the different files and in the settings in src/Doxyfile.in
Also there are a number of settings that are obsolete like:
```
warning: Tag 'LATEX_SOURCE_CODE' at line 1835 of file '.../gudhi-devel/build_windows_fork/Doxyfile' has become obsolete.
```
This is corrected in the src/Doxyfile.in file
|
|
|
|
|
|
|
|
|
|
|
|
|
|
version required. Modification of documentation accordingly
|
|
|
|
|
|
instead of geomview.org documentation. Modify data/points/alphacomplexdoc.off in dimension 3 to be used as an example for OFF section in file format.
|
|
|
|
|
|
module process
Doxyfile.in generates a build/src/Doxyfile that is copied by the user_version target (to avoid file generation in sources)
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ninja_cmake_warning_fix_vincent@3748 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 0a5ab637c2db102a59c994f03f0ec7fadbda3780
|