Commit Graph

115 Commits

Author SHA1 Message Date
Sébastien Loriot b19515e1f8 Merge remote-tracking branch 'cgal/6.0.x-branch' 2025-01-24 08:09:18 +01:00
Sébastien Loriot 7720caa9dc Merge remote-tracking branch 'cgal/5.6.x-branch' into HEAD 2025-01-24 08:08:33 +01:00
Sébastien Loriot d8106aab4b we now use ctest for testing + extra clean up 2025-01-22 11:42:50 +01:00
Sébastien Loriot e4adcceaad more clean up 2025-01-21 11:30:48 +01:00
Sébastien Loriot 36d98614df Merge remote-tracking branch 'cgal/6.0.x-branch' 2025-01-09 19:23:19 +01:00
Laurent Rineau 5eddbc26ae fix build with Doxygen 1.10 and later 2024-12-17 15:48:59 +01:00
albert-github 5c98f77ba2 LaTeX compliance for formulas and errors in bibliography
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
- `&nbsp` 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
2024-12-02 14:58:15 +01:00
Laurent Rineau a0d79b7559 fix the documentation 2024-10-17 00:49:27 +02:00
albert-github dd02af92a2 issue #8515 Spelling mistakes found checking `en-GB` to `en-US`
Spelling corrections, `en-GB` -> `en-US`
2024-10-05 11:28:29 +02:00
albert-github 9fc66c9a26 issue #8334 Incorrect example in "Documentation/doc/Documentation/Developer_manual/create_and_use_a_cmakelist.txt"
The problem surfaced between the releases CGAL 5.3.2 and CGAL 5.4.4.
The "Documentation/doc/Documentation/Developer_manual/create_and_use_a_cmakelist.txt" had not been adjusted for the changes in "Surface_mesh/examples/Surface_mesh/CMakeLists.txt" i.e.
the changes in its structure and also during the change Qt5 -> Qt6 this was not detected.
2024-07-06 10:49:14 +02:00
albert-github 36c8b7589d Spelling corrections
Last batch (for now) of spelling corrections in doxygen and normal comments
2024-05-31 19:05:34 +02:00
Laurent Rineau 48f37a14dc remove occurrences of Qt5 2023-09-14 17:02:21 +02:00
Laurent Rineau 2f6d51b49b Remove a few occurrences of CGAL_Qt5
... and replace by CGAL_Qt6
2023-09-14 16:33:20 +02:00
albert-github b3af96caa1 issue #7454 Consistency of BigO notations
Create `cgalBigO` marco and used it.
(`The macro `cgalBigOLarge` is for special situations where we need bigger round brackets)
2023-07-04 16:23:14 +02:00
Nuno Miguel Nobre 0469f46105 Fix plurals in a number of manuals 2023-06-20 13:29:44 +01:00
Mael 153c603209
Merge branch 'master' into CGAL-Clean_CMakeLists.txt-GF 2023-01-27 22:09:02 +01:00
Mael 0ff7882997
Merge branch 'master' into feature/bug_documentation_spell_20221113 2022-12-06 22:21:06 +01:00
Mael 6538b22e06
Merge branch 'master' into CGAL-Clean_CMakeLists.txt-GF 2022-12-05 16:03:41 +01:00
Laurent Rineau 67b5c791e9 Merge pull request #7075 from MaelRL/CGAL-Fix_some_links-GF
Update some links + https
2022-12-05 12:22:06 +01:00
Andreas Fabri 699454ae84 STL Extensions: Correct spelling 2022-11-29 13:22:00 +00:00
Mael Rouxel-Labbé b5c21e1f5d Http -> https + update some dead links 2022-11-23 18:54:37 +01:00
albert-github dd6b993e07 Documentation: spelling corrections
Some spelling corrections
2022-11-13 13:47:14 +01:00
Laurent Rineau b3174acf53 Add a ref 2022-09-28 14:42:39 +02:00
Laurent Rineau e90b64f1b7 Addition to the section about kernel assertions 2022-09-28 14:02:06 +02:00
Laurent Rineau eea79d0394 Collateral fix of the documentation 2022-09-28 13:39:05 +02:00
Andreas Fabri 6d09a886b2 Remove paragraph in the developer manual; Some fixes 2022-09-23 14:12:53 +01:00
Mael Rouxel-Labbé b78da38490 Add 'REQUIRED' in the documentation's `find_package(CGAL)` usages 2022-09-07 11:42:44 +02:00
Mael Rouxel-Labbé 9b265fddf8 Uniformize REQUIRED / QUIET usage:
Following this:
- CGAL: always REQUIRED
- CGAL component: COMPONENT / OPTIONAL_COMPONENT (never QUIET)
- required 3rd party: (not QUIET) + message(NOTICE "") on NOT_FOUND
- optional 3rd party: QUIET + message(STATUS "") except for Polyhedron/demo
- 3rd party components: COMPONENT / OPTIONAL_COMPONENT
                        (QUIET depending on required or optional 3rd party)
2022-09-06 16:24:27 +02:00
Laurent Rineau 3bd55ca2b2 Remove mention to boost::thread_specific_ptr 2022-06-20 09:35:06 +02:00
Laurent Rineau a0aec6d20a Merge pull request #6659 from afabri/CGAL-fix_boost_doc_URLs-GF
STL_extension: Fix URL to boost libs
2022-06-15 10:18:53 +02:00
Laurent Rineau d9245b9cd6 Remove any mention of result_of in the documentation 2022-06-10 17:26:44 +02:00
Andreas Fabri 60df88453f No longer use the link to boost::result_of 2022-06-09 12:44:10 +01:00
albert-github 5bc8c089a0 Redirect and readability
From review:
- replace `<TT>` by `<blockquote>
- remove `,`
2022-05-16 12:11:40 +02:00
albert-github 34a167c525 Redirect and readability
- correcting permanent redirect
- improve readability
2022-05-13 18:09:08 +02:00
albert-github f3c616ee27
Update Documentation/doc/Documentation/Developer_manual/Chapter_portability.txt
Co-authored-by: Sebastien Loriot <sloriot.ml@gmail.com>
2022-05-10 11:50:09 +02:00
albert-github 939dfbe68a Documentation update in respect to code fragments
- Corrected some another const and mutable based on review
- Corrected BaseDoxyfile.in for other builds of this (5.5) version
2022-04-22 10:31:21 +02:00
albert-github 461dba692d Documentation update in respect to code fragments
Update of documentation in respect of code fragments
- making code fragments work in footnotes
- placing some words in in code tags
- completing some words to code tags
- removing some `#` as they are not necessary
- don't show obfuscation code in email
2022-04-21 17:56:14 +02:00
Sébastien Loriot 3a2177f877 remove deprecated recommendation 2022-03-01 18:52:56 +01:00
albert-github 3ad2b0ff17 Remove some unintended artifacts from the documentation
Some parts were due to to the markdown handling of 4 spaces meaning code converted to code and this was not the intention.
2021-11-25 15:43:21 +01:00
Sébastien Loriot d8510d0fd3 follow up of #4009 2021-08-30 12:37:20 +02:00
albert-github 2a54687e77 Correction of hyperlinks
The link checker gave a number of redirects and incorrect links.
- the redirects have been solved ass far as possible
- the incorrect links have been checked and corrected where possible, others  have been reported through issues;
2021-06-04 13:52:14 +02:00
Maxime Gimeno a76bd6081e Replace more sc text 2021-05-21 15:45:50 +02:00
Giles Bathgate 5ecd85248a Fix capitalisation of macro name. 2021-04-28 21:03:45 +01:00
Giles Bathgate 0ef8127c71 The CGAL_NOEXCEPT macro is no longer needed 2021-04-28 21:03:00 +01:00
Laurent Rineau 3ab3b10d47 Merge pull request #5247 from MaelRL/SDG-Fix_doc-GF
Doc improvements for TDS-related classes
2021-03-03 17:38:18 +01:00
Laurent Rineau 22b823f066 Merge pull request #5434 from maxGimeno/Doc-Dont_use_small_caps-maxGimeno
Doc: Don't use small caps
2021-03-03 17:32:57 +01:00
Mael Rouxel-Labbé 5efa544734 Merge remote-tracking branch 'cgal/master' into SDG-Fix_doc-GF 2021-02-22 17:19:40 +01:00
Laurent Rineau 99225a9a33 Merge pull request #5414 from maxGimeno/Doc-Fix_qt5_example-maxGimeno
Documentation: Re-add missing CMakeLists
2021-02-05 16:09:56 +01:00
Maxime Gimeno fb3746168d remove \sc 2021-02-05 11:10:20 +01:00
Maxime Gimeno 4271f6e19c Restore the CMakelist.txt in the Minimal Example Using Qt5 2021-02-01 09:21:29 +01:00