Skip to content

Commit

Permalink
fix tag
Browse files Browse the repository at this point in the history
  • Loading branch information
afabri committed Dec 7, 2023
1 parent 79262a3 commit 0991fc9
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ The VTK libraries use different file formats to handle data structures, but we o
In the <a href="https://vtk.org/"> VTK Libraries</a>, it is the format
reserved to store `PolyData`, and in \cgal, we use it to store polygon meshes.

We additionally provide a read function for the legacy non-XML file `VTK` file format for polygon meshes.
We additionally provide a read function for the legacy non-XML `VTK` file format for polygon meshes.

A precise specification of those formats is available at
<a href="https://vtk.org/wp-content/uploads/2015/04/file-formats.pdf">vtk.org</a>.
Expand All @@ -455,23 +455,23 @@ A precise specification of those formats is available at
<td rowspan="2" width="75">Input</td>
<td rowspan="1" width="175">Polygon Mesh</td>
<td width="250">Any model of `MutableFaceGraph`</td>
<td width="800">\link PkgBGLIoFuncsVTP CGAL::IO::read_VTP(const std::string&, Graph&)\endlink</td>
<td width="800">\link PkgBGLIoFuncsVTK CGAL::IO::read_VTP(const std::string&, Graph&)\endlink</td>
</tr>
<tr>
<td>Polygon Soup</td>
<td>Any point + polygon range</td>
<td>\link PkgStreamSupportIoFuncsVTP CGAL::IO::read_VTP(const std::string&, PointRange&, PolygonRange&)\endlink, <BR> \link PkgStreamSupportIoFuncsVTP CGAL::IO::read_VTK(const std::string&, PointRange&, PolygonRange&)\endlink</td>
<td>\link PkgStreamSupportIoFuncsVTK CGAL::IO::read_VTP(const std::string&, PointRange&, PolygonRange&)\endlink, <BR> \link PkgStreamSupportIoFuncsVTK CGAL::IO::read_VTK(const std::string&, PointRange&, PolygonRange&)\endlink</td>
</tr>
<tr>
<td rowspan="2">Output</td>
<td rowspan="1">Polygon Mesh</td>
<td>Any model of `FaceGraph`</td>
<td>\link PkgBGLIoFuncsVTP CGAL::IO::write_VTP(const std::string&, Graph&)\endlink</td>
<td>\link PkgBGLIoFuncsVTK CGAL::IO::write_VTP(const std::string&, Graph&)\endlink</td>
</tr>
<tr>
<td>Polygon Soup</td>
<td>Any point + polygon range</td>
<td>\link PkgStreamSupportIoFuncsVTP CGAL::IO::write_VTP(const std::string&, const PointRange&, const PolygonRange&)\endlink</td>
<td>\link PkgStreamSupportIoFuncsVTK CGAL::IO::write_VTP(const std::string&, const PointRange&, const PolygonRange&)\endlink</td>
</tr>
</table>

Expand Down
4 changes: 2 additions & 2 deletions Stream_support/doc/Stream_support/IOstream.txt
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ their indices per face (i.e a vector of 3 integers represent a triangle face).
<td>\link PkgStreamSupportIoFuncsOBJ `read_OBJ()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsSTL `read_STL()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsPLY `read_PLY()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsVTP `read_VTP()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsVTK `read_VTP()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsGOCAD `read_GOCAD()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsWKT `read_WKT()` \endlink</td>
<td>\link PkgStreamSupportIoFuncs3MF `read_3MF()` \endlink</td>
Expand All @@ -398,7 +398,7 @@ their indices per face (i.e a vector of 3 integers represent a triangle face).
<td>\link PkgStreamSupportIoFuncsOBJ `write_OBJ()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsSTL `write_STL()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsPLY `write_PLY()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsVTP `write_VTP()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsVTK `write_VTP()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsGOCAD `write_GOCAD()` \endlink</td>
<td>\link PkgStreamSupportIoFuncsWKT `write_WKT()` \endlink</td>
<td>\link PkgStreamSupportIoFuncs3MF `write_3MF()` \endlink</td>
Expand Down
4 changes: 2 additions & 2 deletions Stream_support/doc/Stream_support/PackageDescription.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/// I/O Functions for the \ref IOStreamOFF
/// \ingroup IOstreamFunctions

/// \defgroup PkgStreamSupportIoFuncsVTP VTK I/O Functions
/// \defgroup PkgStreamSupportIoFuncsVTK VTK I/O Functions
/// I/O Functions for the \ref IOStreamVTK
/// \ingroup IOstreamFunctions

Expand Down Expand Up @@ -96,7 +96,7 @@ the printing mode.
- \link PkgStreamSupportIoFuncsOBJ I/O for OBJ files \endlink
- \link PkgStreamSupportIoFuncsOFF I/O for OFF files \endlink
- \link PkgStreamSupportIoFuncsGOCAD I/O for GOCAD files \endlink
- \link PkgStreamSupportIoFuncsVTP I/O for VTP files \endlink
- \link PkgStreamSupportIoFuncsVTK I/O for VTK files \endlink
- \link PkgStreamSupportIoFuncs3MF I/O for 3MF files \endlink
- \link PkgStreamSupportIoFuncsWKT I/O for WKT files \endlink

Expand Down
8 changes: 4 additions & 4 deletions Stream_support/include/CGAL/IO/VTK.h
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ bool read_VTP(const std::string& fname,
}

/*!
* \ingroup PkgStreamSupportIoFuncsVTP
* \ingroup PkgStreamSupportIoFuncsVTK
*
* \brief reads the content of the input file into `points` and `polygons`, using the \ref IOStreamVTK.
*
Expand Down Expand Up @@ -172,7 +172,7 @@ bool read_VTK(const std::string& fname,
}

/*!
* \ingroup PkgStreamSupportIoFuncsVTP
* \ingroup PkgStreamSupportIoFuncsVTK
*
* \brief reads the content of the input file into `points` and `polygons`, using the legacy file format of the \ref IOStreamVTK.
*
Expand Down Expand Up @@ -398,7 +398,7 @@ void write_soup_polys_points(std::ostream& os,
} // namespace internal

/*!
* \ingroup PkgStreamSupportIoFuncsVTP
* \ingroup PkgStreamSupportIoFuncsVTK
*
* \brief writes the content of `points` and `polygons` in `out`, using the \ref IOStreamVTK.
*
Expand Down Expand Up @@ -486,7 +486,7 @@ bool write_VTP(std::ostream& os,
}

/*!
* \ingroup PkgStreamSupportIoFuncsVTP
* \ingroup PkgStreamSupportIoFuncsVTK
*
* \brief writes the content of `points` and `polygons` in a file named `fname`, using the \ref IOStreamVTK.
*
Expand Down

0 comments on commit 0991fc9

Please sign in to comment.