Commit Graph

440 Commits

Author SHA1 Message Date
Andreas Fabri 61baefa79a
Apply suggestions from code review
Co-authored-by: Mael <mael.rouxel.labbe@geometryfactory.com>
2025-07-15 12:00:44 +02:00
Andreas Fabri 8d4877b025 Triangulation_2: Document degree() 2025-07-09 15:09:42 +01:00
Sebastien Loriot 97bd1cf428
Rename home page of reference manuals to "Reference Manual" (#8904)
Before: "Pkg Reference"
After: "Reference Manual"

No need to repeat the package name as it is on the line above.

Example output
![Screenshot from 2025-05-22
16-18-54](https://github.com/user-attachments/assets/ed285e12-d95c-4ec2-934d-12f4c7aa014c)
2025-05-26 11:47:37 +02:00
Sébastien Loriot 13609a6966 no need to repeat the package name as it is on the line above 2025-05-22 17:53:41 +02:00
Andreas Fabri 2bdeff8687 counter-clockwise -> counterclockwise 2025-05-15 07:41:00 +01:00
Mael Rouxel-Labbé 691fd789f9 Merge remote-tracking branch 'cgal/master' into gsoc2022-isosurface 2025-03-24 21:34:55 +01:00
Sebastien Loriot 8c8618ad04
Remove check doc todos (#8738)
We can consider them as done now
2025-02-19 07:13:33 +01:00
Sébastien Loriot 66965f3a07 remove todo 2025-02-14 11:03:32 +01:00
Sébastien Loriot de1fb95d15 Merge pull request #8658 from MaelRL/Tr-Document_point-GF
Document `point()` in all triangulations
2025-02-12 21:18:27 +01:00
Laurent Rineau 8eefb7f173 Merge branch 'master' into pr/lrineau/8273 2025-02-07 16:10:52 +01:00
Laurent Rineau cf815b823f doc fix: add that iterators are all bidirectional 2025-01-16 14:14:38 +01:00
Laurent Rineau cf50ad8b13 document the breakng change 2025-01-16 13:47:33 +01:00
Laurent Rineau 1f70e59210 doc bug-fix 2025-01-14 14:11:08 +01:00
Laurent Rineau eafa97a862 major cleanup of Polyline_constraint_hierarchy_2
- remove all mentions of `Edge` and `Constraint`
- `Subconstraint_iterator` is renamed `Subconstraint_and_contexts_iterator` (because of its value type)
- a new `Subconstraint_iterator`, with value type `Subconstraint`
- a few unused/untested and uncompilable functions are removed from the code
- a lot of internal renamings

== Breaking changes ==

For `Constrained_triangulation_plus_2`, there are a few breaking changes...

- The value type of `subconstraints_begin()`, `subconstraints_end()`, of the range `subconstraints()` has changed to `Subconstraint` (a simple `std::pair` of vertex handles). That is actually a kind of bug-fix, because it was documented as such in the user manual.
- The new member functions `subconstraints_and_contexts_begin()`, `subconstraints_and_contexts_end()`, `subconstraints_and_contexts()` are created get the old value type (`std::pair<const Subconstraint, std::list<Context>*>`).
- A few range types have changed from `CGAL::Iterator_range<It>` to `unspecified_type`, for efficiency reasons.
- Doc fixes.

== Determinism ==

Even if it was not documented, the range `subconstraints()` is deterministic (used by Mesh_2), and `subconstraints_and_contexts()` is not.
2025-01-13 17:06:58 +01:00
albert-github aaa6adb7c1 In a number of cases the command `@{` (or `\{`) is not closed by a corresponding closing command (`@}`). For the `\=name` command this is apparently not necessary but it is better to have corresponding open and close commands.
(also corrected a split in a line that I noticed in Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h)
2024-12-25 15:09:57 +01:00
Mael Rouxel-Labbé 2b5682f72d Fix missing backslash in math equation 2024-12-13 14:32:48 +01:00
Mael Rouxel-Labbé 195616fcf3 Document point() in 2D Euclidean triangulations 2024-12-13 14:18:35 +01:00
Sven Oesau a06002ab2b Merge remote-tracking branch 'cgal/master' into gsoc2022-isosurface 2024-10-14 14:42:46 +02:00
Andreas Fabri 12468ccf4a Address #8401 2024-08-09 11:32:26 +01:00
Mael Rouxel-Labbé 67aba3fefe Merge remote-tracking branch 'cgal/master' into gsoc2022-isosurface 2024-06-20 10:18:49 +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
albert-github 92a5cc9ea0 Spelling correction
instanciation -> instantiation
2024-05-27 13:01:46 +02:00
Laurent Rineau e313fdc697 Add Compare_xy_2 to TriangulationTraits_2
This enables customization of projection traits for CDT_2s and
facilitates unification with the predicates utilized in
3D triangulations.
2024-04-26 12:13:35 +02:00
Sébastien Loriot 5254404517 Merge remote-tracking branch 'cgal/master' into HEAD 2024-03-27 22:25:41 +01:00
Guillaume Damiand 9a0b8eb824 Merge branch 'master' into gsoc2022-EBVs-Mostafa-ashraf19 2024-03-26 16:25:29 +01:00
albert-github 0a2865b288 When running xmllint over the documentation output we get a number of waning's like:
```
save_Periodic_2_triangulation_2/class_c_g_a_l_1_1_periodic__2__triangulation__2.html:1420: parser error : Opening and ending tag mismatch: dd line 1420 and div
"This is an advanced function.">is_triangulation_in_1_sheet()</a></code>  </div>
                                                                               ^
```
they are a consequence of the fact that a a command is not properly ended in this case we have a `\pre` command and its documentation states:
> The `\pre` command ends when a blank line or some other sectioning command is encountered.

and in this case the command is followed by the `\cgalAdvancedEnd` command that does not properly end the `\pre` command.
The same is valid in the other cases.
2024-02-02 18:58:03 +01:00
Mael Rouxel-Labbé 984a541006 Fix usages of 'th `th 2024-01-23 21:50:04 +01:00
Guillaume Damiand bd04b2a68d Remove space in doc 2023-12-06 17:01:34 +01:00
Guillaume Damiand 4d02be9db3 doc: draw ct2 2023-12-06 17:00:20 +01:00
Guillaume Damiand b34fb266a4 fix doc draw ct2 2023-12-06 16:37:48 +01:00
Guillaume Damiand bfcb44bd8c doc: draw point set 3 and constrained triangulation 2 2023-12-06 16:23:49 +01:00
Guillaume Damiand 029ab430a3 doc draw nef3 2023-12-05 14:58:28 +01:00
Guillaume Damiand 03ff679df4 doc draw: move advanced blocks 2023-12-05 14:10:25 +01:00
Guillaume Damiand df2b9ad172 doc draw pwh 2023-12-05 13:16:54 +01:00
Guillaume Damiand 5b7f499fc1 doc draw polygon 2023-12-05 12:58:30 +01:00
Guillaume Damiand 0655006622 Merge with master: now viewers use Qt6 2023-11-29 14:36:38 +01:00
Laurent Rineau 51627e3505 Merge remote-tracking branch 'cgal/master' into CGAL-Qt6-GF
# Conflicts:
#	GraphicsView/demo/Bounding_volumes/CMakeLists.txt
2023-11-01 20:59:44 +01:00
Guillaume Damiand 2f07fbbb54 Update basic viewer doc following last remarks (Laurent and Andreas) 2023-10-23 19:17:52 +02:00
Guillaume Damiand e416fc8751 new test for doc of draw 2023-10-23 15:38:43 +02:00
Guillaume Damiand 6daa2a0c3b Graphics_scene is no more templated 2023-10-23 01:30:57 +02:00
Guillaume Damiand c9d93bac3b Add GraphicsSceneOptions concept; use it to document draw(T2); waiting @Laurent remarks... 2023-10-22 17:14:18 +02:00
Guillaume Damiand e3f1772037 Rename add_in_graphics_scene -> add_to_graphics_scene 2023-10-18 16:54:16 +02:00
Andreas Fabri e5c84bf099 Triangulation_2: Add some () to function names in the User Manual 2023-10-16 13:18:57 +01:00
Guillaume Damiand 163e8ae2b3 Doc basic viewer 2023-10-13 10:50:04 +02:00
Guillaume Damiand a5ee74cb66 Merge branch 'master' into gsoc2022-EBVs-Mostafa-ashraf19 2023-09-29 08:36:37 +02:00
Guillaume Damiand 9f22d67ed0 Rename Graphic_storage in Graphics_scene (Andreas and Sebastien review) 2023-09-28 12:49:00 +02:00
Guillaume Damiand fd115bd321 Rename Graphic_storare into Graphics_scene (Andreas and Sebastien review) 2023-09-28 11:06:53 +02:00
Guillaume Damiand e5a8a0d006 Pmap readable 2023-09-28 09:55:20 +02:00
Laurent Rineau 28632f21fc Merge branch 'master' into CGAL-Qt6-GF
# Conflicts:
#	Installation/CHANGES.md
2023-09-14 17:40:05 +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