From 6acac6907a360d7e5c597972774d880ddfcd97e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Fri, 24 Jul 2020 09:23:54 +0200 Subject: [PATCH] Add a note about letter case in generic I/O functions --- BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h | 4 ++-- Point_set_3/include/CGAL/Point_set_3/IO.h | 8 ++++---- Point_set_processing_3/include/CGAL/IO/read_points.h | 2 +- Point_set_processing_3/include/CGAL/IO/write_points.h | 2 +- .../CGAL/Polygon_mesh_processing/IO/polygon_mesh_io.h | 2 +- Stream_support/include/CGAL/IO/polygon_soup_io.h | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h b/BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h index dc28d4babe7..7ca2eaed520 100644 --- a/BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h +++ b/BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h @@ -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" diff --git a/Point_set_3/include/CGAL/Point_set_3/IO.h b/Point_set_3/include/CGAL/Point_set_3/IO.h index f26f081ef5c..87f28f58c11 100644 --- a/Point_set_3/include/CGAL/Point_set_3/IO.h +++ b/Point_set_3/include/CGAL/Point_set_3/IO.h @@ -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` diff --git a/Point_set_processing_3/include/CGAL/IO/read_points.h b/Point_set_processing_3/include/CGAL/IO/read_points.h index 45b0fe10926..308a24c798b 100644 --- a/Point_set_processing_3/include/CGAL/IO/read_points.h +++ b/Point_set_processing_3/include/CGAL/IO/read_points.h @@ -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::%type` and can be omitted when the default is fine. diff --git a/Point_set_processing_3/include/CGAL/IO/write_points.h b/Point_set_processing_3/include/CGAL/IO/write_points.h index 84c52cdb955..3877b6726bb 100644 --- a/Point_set_processing_3/include/CGAL/IO/write_points.h +++ b/Point_set_processing_3/include/CGAL/IO/write_points.h @@ -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`. diff --git a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/IO/polygon_mesh_io.h b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/IO/polygon_mesh_io.h index 464310dbbe7..1c94e854d20 100644 --- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/IO/polygon_mesh_io.h +++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/IO/polygon_mesh_io.h @@ -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" diff --git a/Stream_support/include/CGAL/IO/polygon_soup_io.h b/Stream_support/include/CGAL/IO/polygon_soup_io.h index 6f89bf9b62b..3cb03ffe49f 100644 --- a/Stream_support/include/CGAL/IO/polygon_soup_io.h +++ b/Stream_support/include/CGAL/IO/polygon_soup_io.h @@ -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`