## Summary of Changes
Fix that functions shall be written with `()`.
Removed an example with the no longer existing `Window_stream`
This part of the manual needs a real review, as a lot is now directly on
github.
* License and copyright ownership: unchanged
Based on #8320 and https://github.com/doxygen/doxygen/pull/11157 creating an assertion for builds from scratch when a citation name is used multiple times.
(doxygen cannot catch these here as they are directly written into html code).
In the current master version of doxygen (and thus upcoming version 1.14.0) a page outline panel is introduced, setting: `PAGE_OUTLINE_PANEL`, though it would be better to disable this in CGAL.
The formula in Documentation/doc/biblio/cgal_manual.bib
```
@article{cgal:cgm-fobbo-11,
title={Fast Oriented Bounding Box Optimization on the Rotation Group $\SO(3, \mathrm{R})$},
author={Chang, Chia-Tche and Gorissen, Bastien and Melchior, Samuel},
```
renders incorrectly (see Optimal_bounding_box/citelist.html) as there is
no command `\SO` in LaTeX
The formula in doc/Kernel_d/CGAL/Kernel_d/Aff_transformation_d.h
```
\pre \f$ sin_num^2 + cos_num^2 = den^2\f$ and \f$ 0 \leq e_1 < e_2 < d\f$.
```
renders in an unexpected way (see
Kernel_d/classCGAL_1_1Aff__transformation__d.html) as the `_` is seen as
subscript operator in LaTeX
- compare doxygen version with the available directories on disk and
(try to) use the most appropriate one
- give a warning when there are more directories than expected (already
present), though `FATAL` should probably be `FATAL_ERROR` though the
latest will give problems when adding a new version to the directory
list for testing. Changed the message to a `WARNING`
The formula in Documentation/doc/biblio/cgal_manual.bib
```
@article{cgal:cgm-fobbo-11,
title={Fast Oriented Bounding Box Optimization on the Rotation Group $\SO(3, \mathrm{R})$},
author={Chang, Chia-Tche and Gorissen, Bastien and Melchior, Samuel},
```
renders incorrectly (see Optimal_bounding_box/citelist.html) as there is no command `\SO` in LaTeX
The formula in doc/Kernel_d/CGAL/Kernel_d/Aff_transformation_d.h
```
\pre \f$ sin_num^2 + cos_num^2 = den^2\f$ and \f$ 0 \leq e_1 < e_2 < d\f$.
```
renders in an unexpected way (see Kernel_d/classCGAL_1_1Aff__transformation__d.html) as the `_` is seen as subscript operator in LaTeX
That will suppress the warnings about `CMP0167` (from CMake 3.30):
```
CMake Warning (dev) at cmake/modules/display-third-party-libs-versions.cmake:37 (find_package):
Policy CMP0167 is not set: The FindBoost module is removed. Run "cmake
--help-policy CMP0167" for policy details. Use the cmake_policy command to
set the policy and suppress this warning.
```
- compare doxygen version with the available directories on disk and (try to) use the most appropriate one
- give a warning when there are more directories than expected (already present), though `FATAL` should probably be `FATAL_ERROR` though the latest will give problems when adding a new version to the directory list for testing. Changed the message to a `WARNING`
Due to an incompatibility change in doxygen (see 2a62c19755 (commitcomment-150534822)) it is necessary to add the setting for `FULL_SIDEBAR` to the setup of the CGAL documentation.
Correction of incorrect usage of LaTeX in formulas and bibliography
altough MatHJax and bibtex.pl doesn't always signal it.
- Incorrect biblio entry (missing `,` and `}`)
- Documentation/doc/biblio/geom.bib
- ` ` is not correct LaTeX has to be `~`
-
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
- Documentation/doc/Documentation/Developer_manual/Chapter_intro.txt
- Incorrect formula regarding usage of `\left` and `\right` (also
signaled by MathJax
-
Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
- `DeclareMathOperator` is a command that should be in the preamble,
alternatively the command `\operatorname` can be used explicitly (as
done here as it is only used once)
-
Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/Kinetic_surface_reconstruction.txt
- Latex has problems with `_` in a `text...` command so it should be
escaped though this gives problems with MathJax hence the extra hook.
MathJax reference:
https://groups.google.com/g/mathjax-users/c/wSh6-hSIUpQ/m/KmzZhQQGslgJ
- Documentation/doc/resources/1.10.0/CGAL_mathjax.js
- Documentation/doc/resources/1.8.13/CGAL_mathjax.js
- Documentation/doc/resources/1.9.6/CGAL_mathjax.js
- Weights/include/CGAL/Weights/authalic_weights.h
- The `&` in the bibliography has to be escaped
- the doxygen command `\f[` should not be used to directly change the environment, for this the doxygen command `\f{` exists.
Correction of incorrect usage of LaTeX in formulas and bibliography altough MatHJax and bibtex.pl doesn't always signal it.
- Incorrect biblio entry (missing `,` and `}`)
- Documentation/doc/biblio/geom.bib
- ` ` is not correct LaTex has to be `~`
- Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
- Documentation/doc/Documentation/Developer_manual/Chapter_intro.txt
- Incorrect formula regarding usage of `\left` and `\right` (also signaled by MathJax
- Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Arrangement_on_surface_2.txt
- `DeclareMathOperator` is a command that should be in the preamble, alternatively the command `\operatorname` can be used explicitly (as done here as it is only used once)
- Kinetic_surface_reconstruction/doc/Kinetic_surface_reconstruction/Kinetic_surface_reconstruction.txt
- Latex has problems with `_` in a `text...` command so it should be escaped though this gives problems with MathJax hence the extra hook.
MathJax reference: https://groups.google.com/g/mathjax-users/c/wSh6-hSIUpQ/m/KmzZhQQGslgJ
- Documentation/doc/resources/1.10.0/CGAL_mathjax.js
- Documentation/doc/resources/1.8.13/CGAL_mathjax.js
- Documentation/doc/resources/1.9.6/CGAL_mathjax.js
- Weights/include/CGAL/Weights/authalic_weights.h
## Summary of Changes
- Changed `PUBLIC` to `PRIVATE` in the `target_link_libraries()`
- ~~Link against `Boost::<COMPONENT>`~~ as we do more than just linking
and must use the `CGAL::_.._support`
- Use `target_compile_definitions()` and `add_compile_definitions()`
More to be done.
## Release Management
* Affected package(s): all
* Issue(s) solved (if any): fix one item of #4815
* License and copyright ownership: unchanged
Sebastien Loriot
Andreas Fabri
albert-github
Laurent Rineau
Mehul Yadav
Jane Tournois
Sven Oesau
Mael Rouxel-Labbé
lvalque
Léo Valque
POUGET Marc