songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Spelling correction 

instanciation -> instantiation
This commit is contained in:
albert-github 2024-05-27 13:01:46 +02:00
parent d06a57a292
commit 92a5cc9ea0
13 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/draw_polygon_set_2.h
View File

@ -30,7 +30,7 @@ opens a new window and draws a 2D polygon set. Parameters of the drawing are tak
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam PS2 which must be an instanciation of a `CGAL::Polygon_set_2<...>`.
\tparam PS2 which must be an instantiation of a `CGAL::Polygon_set_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptionsPolygonSet2` concept.
\param ps2 the polygon set to draw.
@ -62,7 +62,7 @@ void draw(const PS2& ps2);
adds the vertices, edges and faces of `ps2` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam PS2 which must be an instanciation of a `CGAL::Polygon_set_2<...>`.
\tparam PS2 which must be an instantiation of a `CGAL::Polygon_set_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptionsPolygonSet2` concept.
\param ps2 the polygon set to draw.

4
Linear_cell_complex/doc/Linear_cell_complex/CGAL/draw_linear_cell_complex.h
View File

@ -8,7 +8,7 @@ opens a new window and draws a linear cell complex. Parameters of the drawing ar
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam LCC which must be an instanciation of a `CGAL::Linear_cell_complex_for_combinatorial_map<...>` or `CGAL::Linear_cell_complex_for_generalized_map<...>`.
\tparam LCC which must be an instantiation of a `CGAL::Linear_cell_complex_for_combinatorial_map<...>` or `CGAL::Linear_cell_complex_for_generalized_map<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param lcc the linear cell complex to draw.
@ -40,7 +40,7 @@ A shortcut to `CGAL::draw(lcc, Graphics_scene_options{})`.
adds the vertices, edges and faces of `lcc` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam LCC which must be an instanciation of a `CGAL::Linear_cell_complex_for_combinatorial_map<...>` or `CGAL::Linear_cell_complex_for_generalized_map<...>`.
\tparam LCC which must be an instantiation of a `CGAL::Linear_cell_complex_for_combinatorial_map<...>` or `CGAL::Linear_cell_complex_for_generalized_map<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param lcc the linear cell complex to draw.

4
Nef_3/doc/Nef_3/CGAL/draw_nef_3.h
View File

@ -8,7 +8,7 @@ opens a new window and draws a nef polyhedron. Parameters of the drawing are tak
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam NP3 which must be an instanciation of a `CGAL::Nef_polyhedron_3<...>`.
\tparam NP3 which must be an instantiation of a `CGAL::Nef_polyhedron_3<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param np3 the nef polyhedron to draw.
@ -40,7 +40,7 @@ A shortcut to `CGAL::draw(np3, Graphics_scene_options{})`.
adds the vertices, edges and faces of `np3` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam NP3 which must be an instanciation of a `CGAL::Nef_polyhedron_3<...>`.
\tparam NP3 which must be an instantiation of a `CGAL::Nef_polyhedron_3<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param np3 the nef polyhedron to draw.

4
Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/draw_periodic_2_triangulation_2.h
View File

@ -30,7 +30,7 @@ opens a new window and draws a periodic 2D triangulation. Parameters of the draw
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam P2T2 which must be an instanciation of a `CGAL::Periodic_2_triangulation_2<...>`.
\tparam P2T2 which must be an instantiation of a `CGAL::Periodic_2_triangulation_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptionsPeriodic2Triangulation2` concept.
\param p2t2 the periodic triangulation to draw.
@ -62,7 +62,7 @@ void draw(const P2T2& p2t2);
adds the vertices, edges and faces of `p2t2` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam P2T2 which must be an instanciation of a `CGAL::Periodic_2_triangulation_2<...>`.
\tparam P2T2 which must be an instantiation of a `CGAL::Periodic_2_triangulation_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptionsPeriodic2Triangulation2` concept.
\param p2t2 the periodic triangulation to draw.

4
Point_set_3/include/CGAL/draw_point_set_3.h
View File

@ -31,7 +31,7 @@ opens a new window and draws a point set. Parameters of the drawing are taken fr
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam PS which must be an instanciation of a `CGAL::Point_set_3<...>`.
\tparam PS which must be an instantiation of a `CGAL::Point_set_3<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param ps the point set to draw.
@ -63,7 +63,7 @@ A shortcut to `CGAL::draw(ps, Graphics_scene_options{})`.
adds the vertices, edges and faces of `ps` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam PS which must be an instanciation of a `CGAL::Point_set_3<...>`.
\tparam PS which must be an instantiation of a `CGAL::Point_set_3<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param ps the point set to draw.

4
Polygon/include/CGAL/draw_polygon_2.h
View File

@ -34,7 +34,7 @@ opens a new window and draws a 2D polygon. Parameters of the drawing are taken f
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam P which must be an instanciation of a `CGAL::Polygon_2<...>`.
\tparam P which must be an instantiation of a `CGAL::Polygon_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param p the polygon to draw.
@ -66,7 +66,7 @@ A shortcut to `CGAL::draw(p, Graphics_scene_options{})`.
adds the vertices, edges and faces of `p` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam P which must be an instanciation of a `CGAL::Polygon_2<...>`.
\tparam P which must be an instantiation of a `CGAL::Polygon_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param p the 2D polygon to draw.

4
Polygon/include/CGAL/draw_polygon_with_holes_2.h
View File

@ -34,7 +34,7 @@ opens a new window and draws a 2D polygon with holes. Parameters of the drawing
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam PH which must be an instanciation of a `CGAL::Polygon_with_holes_2<...>`.
\tparam PH which must be an instantiation of a `CGAL::Polygon_with_holes_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param ph the polygon with holes to draw.
@ -66,7 +66,7 @@ A shortcut to `CGAL::draw(ph, Graphics_scene_options{})`.
adds the vertices, edges and faces of `ph` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam PH which must be an instanciation of a `CGAL::Polygon_with_holes_2<...>`.
\tparam PH which must be an instantiation of a `CGAL::Polygon_with_holes_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param ph the polygon with holes to draw.

4
Polyhedron/doc/Polyhedron/CGAL/draw_polyhedron.h
View File

@ -8,7 +8,7 @@ opens a new window and draws a polyhedron. Parameters of the drawing are taken f
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam P which must be an instanciation of a `CGAL::Polyhedron_3<...>`.
\tparam P which must be an instantiation of a `CGAL::Polyhedron_3<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param p the polyhedron to draw.
@ -40,7 +40,7 @@ A shortcut to `CGAL::draw(p, Graphics_scene_options{})`.
adds the vertices, edges and faces of `p` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam P which must be an instanciation of a `CGAL::Polyhedron_3<...>`.
\tparam P which must be an instantiation of a `CGAL::Polyhedron_3<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param p the polyhedron to draw.

4
Surface_mesh/include/CGAL/draw_surface_mesh.h
View File

@ -23,7 +23,7 @@ opens a new window and draws a surface mesh. Parameters of the drawing are taken
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam SM which must be an instanciation of a `CGAL::Surface_mesh<...>`.
\tparam SM which must be an instantiation of a `CGAL::Surface_mesh<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param sm the surface mesh to draw.
@ -55,7 +55,7 @@ A shortcut to `CGAL::draw(sm, Graphics_scene_options{})`.
adds the vertices, edges and faces of `sm` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam SM which must be an instanciation of a `CGAL::Surface_mesh<...>`.
\tparam SM which must be an instantiation of a `CGAL::Surface_mesh<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param sm the surface mesh to draw.

4
Triangulation_2/doc/Triangulation_2/CGAL/draw_constrained_triangulation_2.h
View File

@ -8,7 +8,7 @@ opens a new window and draws a constrained triangulation. If the triangulation h
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam CT2 which must be an instanciation of a `CGAL::Constrained_triangulation_2<...>`.
\tparam CT2 which must be an instantiation of a `CGAL::Constrained_triangulation_2<...>`.
\tparam InDomainPMap a class model of `ReadablePropertyMap` with `CT2::Face_handle` as key type and `bool` as value type.
\param ct2 the constrained triangulation to draw.
@ -32,7 +32,7 @@ The real declaration of this function template is:
adds the vertices, edges and faces of `ct2` into the given graphic scene `gs`. If the triangulation has constraints they are drawn. The faces inside and outside of the domain, based on the property map, are drawn in different colors. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam CT2 which must be an instanciation of a `CGAL::Constrained_triangulation_2<...>`.
\tparam CT2 which must be an instantiation of a `CGAL::Constrained_triangulation_2<...>`.
\tparam InDomainPMap a class model of `ReadablePropertyMap` with `CT2::Face_handle` as key type and `bool` as value type.
\param ct2 the constrained triangulation to draw.

4
Triangulation_2/doc/Triangulation_2/CGAL/draw_triangulation_2.h
View File

@ -8,7 +8,7 @@ opens a new window and draws a triangulation. Parameters of the drawing are take
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam T2 which must be an instanciation of a `CGAL::Triangulation_2<...>`.
\tparam T2 which must be an instantiation of a `CGAL::Triangulation_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param at2 the triangulation to draw.
@ -40,7 +40,7 @@ A shortcut to `CGAL::draw(at2, Graphics_scene_options{})`.
adds the vertices, edges and faces of `at2` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam T2 which must be an instanciation of a `CGAL::Triangulation_2<...>`.
\tparam T2 which must be an instantiation of a `CGAL::Triangulation_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param at2 the triangulation to draw.

4
Triangulation_3/doc/Triangulation_3/CGAL/draw_triangulation_3.h
View File

@ -8,7 +8,7 @@ opens a new window and draws a 3D triangulation. Parameters of the drawing are t
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam T3 which must be an instanciation of a `CGAL::Triangulation_3<...>`.
\tparam T3 which must be an instantiation of a `CGAL::Triangulation_3<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param at3 the triangulation to draw.
@ -39,7 +39,7 @@ void draw(const T3& at3, const GSOptions& gso);
adds the vertices, edges and faces of `at3` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam T3 which must be an instanciation of a `CGAL::Triangulation_3<...>`.
\tparam T3 which must be an instantiation of a `CGAL::Triangulation_3<...>`.
\tparam GSOptions a model of `GraphicsSceneOptions` concept.
\param at3 the triangulation to draw.

4
Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/draw_voronoi_diagram_2.h
View File

@ -30,7 +30,7 @@ opens a new window and draws a 2D voronoi diagram. Parameters of the drawing are
A call to this function blocks the execution of the program until the drawing window is closed. This function requires `CGAL_Qt6`, and is only available if the macro `CGAL_USE_BASIC_VIEWER` is defined.
Linking with the cmake target `CGAL::CGAL_Basic_viewer` will link with `CGAL_Qt6` and add the definition `CGAL_USE_BASIC_VIEWER`.
\tparam VD2 which must be an instanciation of a `CGAL::Voronoi_diagram_2<...>`.
\tparam VD2 which must be an instantiation of a `CGAL::Voronoi_diagram_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptionsVoronoiDiagram2` concept.
\param vd2 the voronoi diagram to draw.
@ -62,7 +62,7 @@ void draw(const VD2& vd2);
adds the vertices, edges and faces of `vd2` into the given graphic scene `gs`. Parameters of the cells are taken from the optional graphics scene options parameter `gso`. Note that `gs` is not cleared before being filled (to enable to draw several data structures in the same basic viewer).
\tparam VD2 which must be an instanciation of a `CGAL::Voronoi_diagram_2<...>`.
\tparam VD2 which must be an instantiation of a `CGAL::Voronoi_diagram_2<...>`.
\tparam GSOptions a model of `GraphicsSceneOptionsVoronoiDiagram2` concept.
\param vd2 the voronoi diagram to draw.