diff options
| author | albert-github <albert.tests@gmail.com> | 2022-05-18 16:47:05 +0200 |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2022-05-18 16:47:05 +0200 |
| commit | 9186772092a0ed31a2cc30328cbfefb4e4d5db2e (patch) | |
| tree | 8281718228e5ec0887f3e330ea8dd76e6420188c /src/common/doc/examples.h | |
| parent | c7afe82e863eb91d122d34f1d34255c04e27b51f (diff) | |
Documentation: Doxygen warnings
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
Diffstat (limited to 'src/common/doc/examples.h')
| -rw-r--r-- | src/common/doc/examples.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/common/doc/examples.h b/src/common/doc/examples.h index 879fb96a..556a24f1 100644 --- a/src/common/doc/examples.h +++ b/src/common/doc/examples.h @@ -1,6 +1,6 @@ // List of GUDHI examples and utils - Doxygen needs at least a file tag to analyse comments // Generated from scripts/cpp_examples_for_doxygen.py -/*! @file Examples +/*! @file * \section Witness_complex_example_section Witness_complex * @example strong_witness_persistence.cpp * @example weak_witness_persistence.cpp |