mirror of https://github.com/CGAL/cgal
Add a note about letter case in generic I/O functions
This commit is contained in:
parent
22d598e0f3
commit
6acac6907a
|
|
@ -138,7 +138,7 @@ bool read_polygon_mesh(const std::string& fname, Graph& g)
|
|||
* - \ref IOStreamGocad (`.ts`)
|
||||
* - \ref IOStreamVTK (`.vtp`)
|
||||
*
|
||||
* The format is detected from the filename extension.
|
||||
* The format is detected from the filename extension (letter case is not important).
|
||||
*
|
||||
* \tparam Graph a model of `MutableFaceGraph`
|
||||
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
|
||||
|
|
@ -261,7 +261,7 @@ bool write_polygon_mesh(const std::string& fname, Graph& g)
|
|||
* - \ref IOStreamGocad (`.ts`)
|
||||
* - \ref IOStreamVTK (`.vtp`)
|
||||
*
|
||||
* The format is detected from the filename extension.
|
||||
* The format is detected from the filename extension (letter case is not important).
|
||||
*
|
||||
* \tparam Graph a model of `FaceListGraph` and `HalfedgeListGraph`
|
||||
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
|
||||
|
|
|
|||
|
|
@ -118,9 +118,9 @@ bool read_point_set(const std::string& fname,
|
|||
- \ref IOStreamLAS (`.las`)
|
||||
- \ref IOStreamXYZ (`.xyz`)
|
||||
|
||||
The format is detected from the filename extension. If the file contains
|
||||
normal vectors, the normal map is added to the point set. For PLY
|
||||
input, all point properties found in the header are added.
|
||||
The format is detected from the filename extension (letter case is not important).
|
||||
If the file contains normal vectors, the normal map is added to the point set.
|
||||
For PLY input, all point properties found in the header are added.
|
||||
|
||||
\tparam Point a `CGAL::Point_3`
|
||||
\tparam Vector a `CGAL::Vector_3`
|
||||
|
|
@ -200,7 +200,7 @@ bool write_point_set(const std::string& fname,
|
|||
- \ref IOStreamLAS (`.las`)
|
||||
- \ref IOStreamXYZ (`.xyz`)
|
||||
|
||||
The format is detected from the filename extension.
|
||||
The format is detected from the filename extension (letter case is not important).
|
||||
|
||||
\tparam Point a `CGAL::Point_3`
|
||||
\tparam Vector a `CGAL::Vector_3`
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@ bool read_points(const std::string& fname, OutputIterator output)
|
|||
- \ref IOStreamLAS (`.las`)
|
||||
- \ref IOStreamXYZ (`.xyz`)
|
||||
|
||||
The format is detected from the filename extension.
|
||||
The format is detected from the filename extension (letter case is not important).
|
||||
|
||||
\tparam OutputIteratorValueType type of objects that can be put in `PointOutputIterator`.
|
||||
It is default to `value_type_traits<PointOutputIterator>::%type` and can be omitted when the default is fine.
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ bool write_points(const std::string& fname,const PointRange& points,
|
|||
- \ref IOStreamLAS (`.las`)
|
||||
- \ref IOStreamXYZ (`.xyz`)
|
||||
|
||||
The format is detected from the filename extension.
|
||||
The format is detected from the filename extension (letter case is not important).
|
||||
|
||||
\tparam PointRange is a model of `ConstRange`. The value type of
|
||||
its iterator is the key type of the named parameter `point_map`.
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ namespace Polygon_mesh_processing {
|
|||
* - \ref IOStreamGocad (`.ts`)
|
||||
* - \ref IOStreamVTK (`.vtp`)
|
||||
*
|
||||
* The format is detected from the filename extension.
|
||||
* The format is detected from the filename extension (letter case is not important).
|
||||
*
|
||||
* \tparam PolygonMesh a model of `MutableFaceGraph`
|
||||
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ bool read_polygon_soup(const std::string& fname, PointRange& points, PolygonRang
|
|||
* - \ref IOStreamGocad (`.ts`)
|
||||
* - \ref IOStreamVTK (`.vtp`)
|
||||
*
|
||||
* The format is detected from the filename extension.
|
||||
* The format is detected from the filename extension (letter case is not important).
|
||||
*
|
||||
* \tparam PolygonRange a model of the concept `RandomAccessContainer`
|
||||
* whose value_type is a model of the concept `RandomAccessContainer`
|
||||
|
|
@ -211,7 +211,7 @@ bool write_polygon_soup(const std::string& fname, PointRange& points, PolygonRan
|
|||
* - \ref IOStreamGocad (`.ts`)
|
||||
* - \ref IOStreamVTK (`.vtp`)
|
||||
*
|
||||
* The format is detected from the filename extension.
|
||||
* The format is detected from the filename extension (letter case is not important).
|
||||
*
|
||||
* \tparam PolygonRange a model of the concept `RandomAccessContainer`
|
||||
* whose value_type is a model of the concept `RandomAccessContainer`
|
||||
|
|
|
|||
Loading…
Reference in New Issue