From 2d203cae0ce33863b06e6bd38961dc1f0271d6da Mon Sep 17 00:00:00 2001 From: Andreas Fabri Date: Mon, 6 Mar 2023 21:27:04 +0000 Subject: [PATCH] BGL: Document use_binary_mode --- BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h | 7 +++++++ 1 file changed, 7 insertions(+) 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 6c156266172..d60af3c9949 100644 --- a/BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h +++ b/BGL/include/CGAL/boost/graph/IO/polygon_mesh_io.h @@ -201,6 +201,13 @@ bool read_polygon_mesh(const std::string& fname, * \cgalParamExtra{This parameter is only meaningful while using \ascii encoding.} * \cgalParamNEnd * + * \cgalParamNBegin{use_binary_mode} + * \cgalParamDescription{indicates whether data should be written in binary (`true`) or in \ascii (`false`)} + * \cgalParamType{Boolean} + * \cgalParamDefault{`true`} + * \cgalParamExtra{This parameter is only meaningful for formats that support binary encoding.} + * \cgalParamNEnd + * * \cgalParamNBegin{verbose} * \cgalParamDescription{whether extra information is printed when an incident occurs during reading} * \cgalParamType{Boolean}