Commit Graph

288 Commits

Author SHA1 Message Date
albert-github ee2a55279d issue #7395 Improvement of layout of model relations
- Completed the cgalHasModel part
- corrected spelling of `Has Model` and `Is Model Of` to `Has model` and `Is model of`
2023-07-06 17:35:34 +02:00
albert-github c0db92d0e9 issue #7395 Improvement of layout of model relations
Consistent implementation for the `AABB_tree` in respect to `Has Model` and `Is Model Of`
2023-07-05 12:13:40 +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
Andreas Fabri 0f4f903f60 merge cgal/master 2023-06-24 10:24:15 +01:00
Sébastien Loriot 29b84248f8 missing 6.0 updates
# Conflicts:
#	Documentation/doc/resources/1.8.20/menu_version.js
#	Documentation/doc/resources/1.8.4/menu_version.js
#	Documentation/doc/resources/1.9.3/menu_version.js
2023-06-13 12:50:04 +02:00
Mael Rouxel-Labbé cab9751987 Merge remote-tracking branch 'cgal/master' into Mesh_3-doc_fixes-GF 2023-05-31 11:30:19 +02:00
Sébastien Loriot 61f3865f51 fix bad merge 2023-05-25 15:21:25 +02:00
Sébastien Loriot 50679f5034 Merge remote-tracking branch 'cgal/master' into HEAD 2023-05-24 09:55:21 +02:00
Sébastien Loriot 075421890c Merge remote-tracking branch 'cgal/5.5.x-branch' 2023-05-24 09:35:53 +02:00
Sébastien Loriot 341323f4e4 Merge remote-tracking branch 'cgal/5.4.x-branch' into HEAD 2023-05-24 09:29:40 +02:00
Sébastien Loriot 96753beb19 accomodate search box updates 2023-05-23 18:09:06 +02:00
Sébastien Loriot 12b32f6be4 move custom mathjax into dedicated .js 2023-05-23 18:08:44 +02:00
Sébastien Loriot 732da62bd4 use default stylesheet (was already the case before) 2023-05-23 14:33:24 +02:00
Sébastien Loriot 5b532d2466 update from 1.8.20 to 1.9.6 2023-05-23 13:45:43 +02:00
Sébastien Loriot a9cc880bc4 verbatim copy of doxygen style sheet 2023-05-23 13:45:33 +02:00
Sébastien Loriot 7453af0bee remove options that are default + png used only in 1.8.4 2023-05-23 13:44:32 +02:00
Sébastien Loriot a10e704b56 remove no longer supported versions 2023-05-23 13:39:21 +02:00
Sébastien Loriot c4d6c23218 add macro 2023-05-23 08:43:52 +02:00
Sébastien Loriot 697cc786e2 Merge branch 'master' into HEAD 2023-05-23 08:39:48 +02:00
Sébastien Loriot 21320a02ef Merge remote-tracking branch 'cgal/5.4.x-branch' into HEAD 2023-05-19 18:05:03 +02:00
Sebastien Loriot 243adaaa05
Update doc testsuite to use 1.9.6 (#7441)
Replaces #6178
2023-05-19 18:03:05 +02:00
Sébastien Loriot a78afb74bf fix syntax 2023-05-17 09:58:33 +02:00
Sébastien Loriot e1ac0e56e0 add new macro 2023-05-17 09:21:33 +02:00
Sébastien Loriot d5d257d9b1 fix doc 2023-05-15 17:34:56 +02:00
Sébastien Loriot eb29538403 add resources for doxygen 1.9.6 2023-05-12 16:05:30 +02:00
Laurent Rineau f55f187df1 Merge pull request #7394 from albert-github/feature/bug_advanced_end_pre
Incorrect HTML code in relation with \cgalAdvancedEnd
2023-05-11 16:55:32 +02:00
Laurent Rineau fc98360c77 Merge pull request #7402 from albert-github/feature/bug_png_svg
Update CGAL stylesheet
2023-05-03 15:05:38 +02:00
Michael Hoffmann a5cfd5ebad add cgalepicexact macro for all doxygen versions 2023-04-28 09:09:55 +02:00
Michael Hoffmann cfa16aa95f Document which constructions are exact in EPIC. 2023-04-27 12:14:36 +02:00
albert-github 42b84bbbf2 Update CGAL stylesheet
A number of png images ("icons") have been replaced by svg images but this has not been updated in the CGAL used stylesheet
2023-04-23 11:52:55 +02:00
albert-github d36e94d5ab Incorrect HTML code in relation with \cgalAdvancedEnd
In #5226 we already fixed a problem regarding the subtle interaction between the `cgaAdvancedEnd` command and table rows / columns.
In this PR a subtle interaction between the `\cgalAdvancedEnd` and the `pre` command is solved.

xmllint gave the following type warning:
```
Periodic_2_triangulation_2/classCGAL_1_1Periodic__2__triangulation__2.html:1418: parser error : Opening and ending tag mismatch: dd line 1418 and div
"This is an advancedSurface_mesh_deformation function.">is_triangulation_in_1_sheet()</a></code>  </div>
```
this type of warning appeared for the packages:
- Periodic_2_triangulation_2
- Point_set_3
- TDS_3
- Triangulation
- Triangulation_2

for the package Surface_mesh_skeletonization we again saw a warning like:
```
Surface_mesh_skeletonization/classCGAL_1_1Mean__curvature__flow__skeletonization.html:519: parser error : Opening and ending tag mismatch: td line 519 and div
raph_traits&lt;TriangleMesh&gt;::vertex_descriptor</code> as value type.  </div>
```
this is also fixed with this PR.
2023-04-18 12:56:47 +02:00
albert-github 6d279d976d Incorrect usage of `xmlns` in HTML headers
In #7075 the usage of `xmlns` was changed from:
```
<html xmln="https://www.w3.org/1999/xhtml">
```
into
```
<html xmlns="https://www.w3.org/1999/xhtml">
```

this is not correct, the usage has to be `http`  as in the definition https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd we see:
```
<!-- the namespace URI designates the document profile -->

<!ELEMENT html (head, body)>
<!ATTLIST html
  %i18n;
  id          ID             #IMPLIED
  xmlns       %URI;          #FIXED 'http://www.w3.org/1999/xhtml'
  >
```
2023-04-18 10:45:39 +02:00
Laurent Rineau 824976a003 Merge pull request #7236 from albert-github/feature/issue_7231
issue #7231 Improvement of layout of refines relations.
2023-04-17 10:14:01 +02:00
Laurent Rineau 721d789e5b Update menu_version.js 2023-04-06 12:06:41 +02:00
albert-github 2d60f46985 issue #7231 Improvement of layout of refines relations.
- Adjusted cgalRefines according to reviews
- Implemented it in all files
2023-03-14 17:37:50 +01:00
albert-github 19c97b031e Merge branch 'master' into feature/issue_7231 2023-03-14 12:19:05 +01:00
Laurent Rineau e95b5daead Prep for 5.4.4 and 5.5.2 2023-02-28 10:22:31 +01:00
albert-github 57e900b47c Making description of author(s) of a package consistent
- use `\cgalPckAuthor` in case of one author
- use of `\cgalPckAuthors` in case of multiple authors
- using in case of multiple authors always `, and `
- in the 1.9.6 `BaseDoxyfile.in` let the `\cgalPckAuthors` point to `\cgalPckAuthor` to get consistent output (not done for other versions as in the past the `ALIASES` could not call one another).
2023-02-02 18:40:44 +01:00
albert-github 106e7d4325 issue #7231 Improvement of layout of refines relations.
Updating the 1.8.4 and 1.8.13 version as well
2023-02-02 09:44:01 +01:00
albert-github d7f3bba742 issue #7231 Improvement of layout of refines relations.
Implemented:
- no extra "Refines" page
- Refines on one line
- Refines always in code style
- `2 arguments` -> `two arguments`  (for consistency
- added also the `\qualifier`

Implemented in  Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h
Results a.o.
- doc_output/Kernel_23/classKernel_1_1Circle__2.html
- doc_output/Kernel_23/classKernel_1_1BoundedSide__3.html

Note: due to the fact that this is a test implementation pages outside the scope of Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h might not be correct (in respect to code appearance of refines and multiple refines)
2023-02-01 18:13:16 +01:00
Mael Rouxel-Labbé b5c21e1f5d Http -> https + update some dead links 2022-11-23 18:54:37 +01:00
Laurent Rineau d24b180293 Merge branch 'master' into gsoc2022-boost_np 2022-10-28 15:39:36 +02:00
Laurent Rineau a4248d0ca4 Update versions in the doc menu 2022-10-12 16:33:30 +02:00
Laurent Rineau b8e342d845 Update Documentation/doc/resources/1.9.3/menu_version.js
... with the same copy as the other versions!

Fix #6886.
2022-09-27 15:20:32 +02:00
Sébastien Loriot d191d4474a Revert "fix not documented warnings"
This reverts commit 8d773c56348c4055d963c57426d60d118915d22b.
2022-09-23 14:04:51 +02:00
Sébastien Loriot 6397378bdc fix not documented warnings 2022-09-23 13:29:40 +02:00
Sébastien Loriot d8f0bc4c08 dedicated macro for precondition 2022-09-21 09:42:32 +02:00
Sébastien Loriot 681120764e please the CI with a new macro 2022-09-21 09:36:41 +02:00
Laurent Rineau c96f5ddfe4 Merge pull request #6795 from albert-github/feature/bug_obsolete_transparent
Obsolete doxygen settings
2022-08-29 11:35:52 +02:00
albert-github e1a5a3cd1d Divider between treeview and text
In doxygen the setting `HTML_COLORSTYLE` has been introduced with as default `AUTO_LIGHT` but due to the current strategy of CGAL in respect to HTML stylesheets the divider between the treeview and the text is not properly  visible anymore. Due to the same strategy the setting to `AUTO_LIGHT` does not make sense for CGAL.
When setting `HTML_COLORSTYLE=LIGHT` the divider is properly visible again.
2022-08-17 12:30:35 +02:00
albert-github d1895dce99 Obsolete doxygen settings
In the current master the settings `DOT_TRANSPARENT` and `FORNULA_TRANSPARENT` are obsolete.
2022-08-11 13:42:49 +02:00
Sebastien Loriot cd883c678b
Merge pull request #6778 from albert-github/feature/bug_obsolete_dot
Replacing OBSOLETE doxygen settings
2022-08-03 19:58:49 +02:00
albert-github 07fb04e860 Replacing OBSOLETE doxygen settings
Replacing the doxygen obsolete settings with the new settings
2022-08-01 12:31:46 +02:00
albert-github 68a4fdcedc Confusing line numbers in case of warnings
Based on the problems with the line numbers in some warnings, see review of https://github.com/CGAL/cgal/pull/6688 one of the problems was the `ALIASES` for figures, here we have the code `\latexonly ^^ \endlatexonly` though the code in the `\latexonly` part should be LaTeX commands. Here the "attempted" newline is not necessary at all so the `^^` can be removed leaving an empty `\latexonly` part that can be removed as well.

There are a number of other numbering problems found in https://github.com/CGAL/cgal/pull/6688 but they are on the doxygen side as a proposed pull request https://github.com/doxygen/doxygen/pull/9465 has been submitted.
2022-07-21 18:47:08 +02:00
Laurent Rineau 10f5fa4f1e Prepare CGAL-5.5 2022-06-29 14:52:29 +02:00
Laurent Rineau 1cdf1ee26a Update menu_version.js 2022-05-19 16:50:57 +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
Laurent Rineau e7643c90d9 Merge branch '5.4.x-branch' 2022-01-31 17:29:17 +01:00
Laurent Rineau 959bbf105c CGAL-5.3.2 was not published today
... it will be published with CGAL-5.4.1.
2022-01-31 17:28:04 +01:00
Laurent Rineau e86b6f6643 Merge branch '5.4.x-branch' 2022-01-27 12:14:09 +01:00
Laurent Rineau c58ac97e93 Prepare 5.4.x-branch for the release of version 5.4 2022-01-27 12:12:21 +01:00
Sébastien Loriot 10b0af3092 rename macro since Named_function_parameter is part of STL_Extension 2022-01-13 14:43:34 +01:00
Sébastien Loriot c169c41240 Merge remote-tracking branch 'maxGimeno/PMP-Example_of_new_mp_function-maxGimeno' into HEAD 2022-01-12 13:33:49 +01:00
Laurent Rineau 20cdd62d07 Merge pull request #6230 from sloriot/CGAL-doxy_default
Update latest default
2022-01-12 11:41:26 +01:00
Sébastien Loriot e3a2eb8f23 update default 2022-01-10 11:29:46 +01:00
Sébastien Loriot 9112001f33 fix doc 2022-01-06 19:11:54 +01:00
Sébastien Loriot 9714557046 replace overloads with default parameters (PMP) 2022-01-05 14:41:46 +01:00
Sébastien Loriot a6d9b99466 move macros in BaseDoxyfile 2022-01-04 11:10:09 +01:00
Sébastien Loriot 67477b4fc0 add resource files for 1.9.3
cherry-picked from 011178da01
2021-12-27 08:33:21 +01:00
Laurent Rineau c5d01fc96e This branch now targets a possible 5.4-beta2 2021-12-17 17:41:29 +01:00
Laurent Rineau 2010a410e2 Prepare CGAL-5.4-beta1 2021-12-14 15:35:03 +01:00
Mael Rouxel-Labbé c14d65a858 Make the name of each named parameter selectable (doc) 2021-10-26 14:29:38 +02:00
Mael Rouxel-Labbé 521c72d57e Fix typos 2021-10-04 13:34:07 +02:00
Sébastien Loriot 011178da01 add resource files for 1.9.3 2021-08-24 14:36:54 +02:00
albert-github fab536d6f9 Interaction between `HAVE_DOT` setting and inheritance graph
In the BGL package we get a warning like:
```
/home/cgal-testsuite/cgal_doc_build/CGAL-5.4-Ic-33/doc/BGL/PackageDescription.txt:29: warning: ignoring \dot command because HAVE_DOT is not set
```
The BGL package uses the `\dot` and has now to use the setting `HAVE_DOT=YES` to see the dot image.
Till now this went OK as the `\dot` command didn't look at the setting of the `HAVE_DOT` setting in the Doxyfile, though by the issue https://github.com/doxygen/doxygen/issues/7273 and the pull request https://github.com/doxygen/doxygen/pull/8663 it is now required that `HAVE_DOT` is set.
The idea of setting `HAVE_DOT` for the BGL project removed the warning (and shows the figure again) though has also as side effect that the inheritance graphs are shown. Until now CGAL shows for the inheritance just the text version.

Doxygen now has for the `CLASS_GRAPH` setting the possibility `TEXT` that does exactly what is required.

Due to the general setting of `HAVE_DOT` also the not needed `graph_legend` was generated and some `INCLUDE_GRAPH`s, by setting this to `NO ` these are no suppressed as well.
2021-08-24 12:21:07 +02:00
albert-github 96d7986e41 Removing obsolete doxygen settings
```
warning: Tag 'LATEX_SOURCE_CODE' at line 1971 of file '.../doc_dxy/BaseDoxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 2061 of file '.../doc_dxy/BaseDoxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2166 of file '.../BaseDoxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
```
these tags have been declared obsolete (in the current master version), so they should be removed..
CGAL doesn't use the involved formats so this has no influence on the CGAL documentation processing.
2021-08-15 13:55:32 +02:00
Laurent Rineau b9743fffa3 Merge pull request #5741 from danston/Solvers-add_osqp-danston
[Small Feature] OSQP Support in Solver Interface
2021-07-27 15:55:23 +02:00
Sebastien Loriot 40f507a1f1
Merge pull request #5800 from MaelRL/SS-Doc_fixes-GF
Harmonization of some IO stream documentation
2021-07-19 07:56:48 +02:00
Mael 0426fd674c
Add the ASCII alias for doxygen 1.8.4 2021-07-08 23:58:14 +02:00
Laurent Rineau 484ee4c6c4 Change the release name, from 5.3-beta2 to 5.3
...and prepare for the near publication of 5.1.5 and 5.2.3.
2021-07-02 12:46:43 +02:00
Mael Rouxel-Labbé 78ff9185b3 Harmonize ASCII usage across all packages 2021-06-23 23:34:32 +02:00
Dmitry Anisimov 94b75803c0
Merge branch 'master' into Solvers-add_osqp-danston 2021-06-18 10:02:11 +02:00
Laurent Rineau 3dce682668 CGAL-5.3-beta1 was released 2021-06-11 09:58:18 +02:00
Laurent Rineau ac5d63d479 Prepare CGAL-5.3-beta1 2021-06-02 14:45:48 +02:00
Dmitry Anisimov 267a6412ac initial commit with the new osqp solver concept 2021-05-31 14:01:08 +02:00
Laurent Rineau 908049d7f4 Merge pull request #5715 from albert-github/feature/bug_formula_snap_def
Adding items to central MATHJAX_CODEFILE
2021-05-27 19:12:32 +02:00
Maxime Gimeno a76bd6081e Replace more sc text 2021-05-21 15:45:50 +02:00
albert-github b959a03f4b Adding items to central MATHJAX_CODEFILE
In pull request  #4644 a central MATHJAX_CODEFILE was introduced, but the snap rounding package was omitted, so this is corrected here.
For the MathJax V3 ( see #5707) this change is even mandatory (the current construct doesn't work).
2021-05-16 11:09:06 +02:00
albert-github 1b6548b0cc Extra white space at bottom of page
Below the bottom blue block we see for the packages some extra white space. For the Manual page this white space is not present.
The reason is the placing of the "hack.js" code.
2021-05-10 10:59:19 +02:00
Sébastien Loriot 72bc88d38f do not link in the macro 2021-04-08 18:28:24 +02:00
albert-github 453b611002 OUTPUT_TEXT_DIRECTION has been made obsolete
The doxygen setting OUTPUT_TEXT_DIRECTION is obsolete
2021-03-19 12:35:30 +01:00
Maxime Gimeno 483104f514 Don't forget 1.8.4 2021-02-18 15:39:37 +01:00
Maxime Gimeno fb3746168d remove \sc 2021-02-05 11:10:20 +01:00
Laurent Rineau 5e2d8c8fd1
Merge pull request #4255 from maxGimeno/CGAL_IO-maxGimeno 2021-01-14 15:33:51 +01:00
Maxime Gimeno 3d1c41fd14 Merge remote-tracking branch 'cgal/master' into CGAL_IO-maxGimeno 2021-01-07 15:05:28 +01:00
albert-github c3235cd86f Obsolete doxygen setting COLS_IN_ALPHA_INDEX
In the version 1.9.0 the setting `COLS_IN_ALPHA_INDEX` has been made obsolete and generates a warning during building.
As the default value is used it can also be removed (doxygen will automatically take the default value in the older versions).
2021-01-07 11:16:46 +01:00
Laurent Rineau 33b38f11a9 5.1.2 has been published 2020-12-22 17:11:39 +01:00
Laurent Rineau 67a7c1bd9b Merge branch '5.2.x-branch' 2020-12-18 15:59:43 +01:00
Laurent Rineau 485e672c26 Prepare for 5.2 final version 2020-12-18 15:58:54 +01:00