diff --git a/Combinatorial_map/include/CGAL/Element_topo.h b/Combinatorial_map/include/CGAL/Element_topo.h index 4ef5d0c1776..f37a18c6278 100644 --- a/Combinatorial_map/include/CGAL/Element_topo.h +++ b/Combinatorial_map/include/CGAL/Element_topo.h @@ -78,7 +78,7 @@ cell_topo topo_from_name(const std::string& t) } /** - * @brief To get the type of dimD cell of the CMap of cmapdim dimension. + * @brief To get the type of `dimD` cell of the `CMap` of `cmapdim` dimension. */ template diff --git a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex/IO/VTK.h b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex/IO/VTK.h index 48755d80425..07f6dd4327c 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex/IO/VTK.h +++ b/Linear_cell_complex/doc/Linear_cell_complex/CGAL/Linear_cell_complex/IO/VTK.h @@ -6,7 +6,7 @@ namespace IO { * format. * * Only supports: - * - Linear_cell_complex_for_combinatorial_map<3,3> + * - `CGAL::Linear_cell_complex_for_combinatorial_map<3,3>` * - VTK legacy ASCII format (.vtk files) * - Optional scalar fields for vertices and volumes * @@ -23,14 +23,14 @@ namespace IO { /** * \brief Reads a VTK legacy ASCII file and load it into a 3D - * Linear_cell_complex. + * linear cell complex. * \ingroup PkgLinearCellComplexRefIOVTK * * \tparam LCC must be a `CGAL::Linear_cell_complex_for_combinatorial_map<3,3>` * \tparam VertexScalarType Type for vertex scalar data (default: float) * \tparam VolumeScalarType Type for volume scalar data (default: float) * \param filename Path to the VTK file - * \param alcc The Linear_cell_complex to populate (will be cleared first) + * \param alcc The linear cell complex to populate (will be cleared first) * \param vertex_scalars Optional output vector to store per-vertex scalar values. * If provided, will be resized to match number of vertices. * \param volume_scalars Optional output vector to store per-volume scalar values. @@ -51,7 +51,7 @@ bool read_VTK(const char* filename, * \tparam VertexScalarType Type for vertex scalar data (default: float) * \tparam VolumeScalarType Type for volume scalar data (default: float) * \param filename Path to the output VTK file - * \param alcc The Linear_cell_complex to export + * \param alcc The linear cell complex to export * \param vertex_scalars Optional per-vertex scalar data. If provided, must have * same size as number of vertex attributes in the LCC. * \param volume_scalars Optional per-volume scalar data. If provided, must have diff --git a/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt b/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt index 0a04ceb347d..94672f31b71 100644 --- a/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt +++ b/Linear_cell_complex/doc/Linear_cell_complex/Linear_cell_complex.txt @@ -289,15 +289,15 @@ The following example shows the use of \link GenericMap::insert_cell_1_between_t Result of the run of the linear_cell_complex_3_insert program. A window shows the 3D cube where one face has a hole. \cgalFigureEnd -\subsection Linear_cell_complexWriteVTK Write a Linear Cell Complex in a VTK File +\subsection Linear_cell_complexWriteVTK Writing a Linear Cell Complex to a VTK File \anchor ssecLCCWriteVtK -This example loads a 3D linear cell complex from a `.3map` file (using the `operator>>`). It computes for each 3-cell (volume) the number of incident vertices (0-cells), stores these values in a `std::vector`, and writes the result to a `.vtk` file with `CGAL::IO::write_VTK()`, using the computed values as scalars for each volume. +This example loads a 3D linear cell complex from a `.3map` file (using the `operator>>`). It computes for each 3-cell (volume) the number of incident vertices (0-cells), stores these values in a `std::vector`, and writes the result to a `.vtk` file using `CGAL::IO::write_VTK()`, with the computed values as scalars for each volume. \cgalExample{Linear_cell_complex/linear_cell_complex_3_vtk_io.cpp} \cgalFigureBegin{fig_lcc_export_vtk,lcc-export-vtk.png} -Visualization of the VTK file generated by the linear_cell_complex_3_vtk_io program, using Paraview. Each volume is colored depending on its number of vertices. +Visualization of the VTK file generated by the `linear_cell_complex_3_vtk_io` program, using Paraview. Each volume is colored depending on its number of vertices. \cgalFigureEnd