From 91faa22b4abb394d3645ac3f1f05e7f9271b2cc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Fri, 17 Jul 2020 12:22:11 +0200 Subject: [PATCH] Fix some I/O doc in Polyhedron --- Polyhedron/doc/Polyhedron/Polyhedron.txt | 22 +++++++------------ .../doc/Stream_support/IOstream.txt | 6 +++-- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/Polyhedron/doc/Polyhedron/Polyhedron.txt b/Polyhedron/doc/Polyhedron/Polyhedron.txt index 4dcef22d407..2d50d686717 100644 --- a/Polyhedron/doc/Polyhedron/Polyhedron.txt +++ b/Polyhedron/doc/Polyhedron/Polyhedron.txt @@ -298,16 +298,11 @@ surface and its point coordinates. It ignores a possible plane equation or any user-added attributes, such as color. The default file format supported in \cgal for output as well as for -input is the %Object File Format, OFF, with file extension .off, -which is also understood by Geomview \cgalCite{cgal:p-gmgv16-96}. For OFF -an ASCII and a binary format exist. The format can be selected with -the \cgal modifiers for streams, `set_ascii_mode()` and -`set_binary_mode()` respectively. The modifier `set_pretty_mode()` -can be used to allow for (a few) structuring comments in the -output. Otherwise, the output would be free of comments. The default -for writing is ASCII without comments. Both, ASCII and binary format, -can be read independent of the stream setting. Since this file format -is the default format, iostream operators are provided for it. +input is the \ref IOStreamOFF, with file extension .off, +which is also understood by Geomview \cgalCite{cgal:p-gmgv16-96}. +The modifier `set_pretty_mode()` can be used to allow for (a few) structuring comments in the output. +Otherwise, the output would be free of comments. The default for writing is without comments. +Since this file format is the default format, iostream operators are provided for it. \code{.cpp} #include @@ -324,8 +319,8 @@ CGAL::Polyhedron_3& P); Additional formats supported for writing are OpenInventor (.iv) \cgalCite{cgal:w-impoo-94}, VRML 1.0 and 2.0 (.wrl) -\cgalCite{cgal:bpp-vrml-95}, \cgalCite{cgal:vrmls-97}, \cgalCite{cgal:hw-vrml2h-96}, and Wavefront Advanced -Visualizer object format (.obj). Another convenient output +\cgalCite{cgal:bpp-vrml-95}, \cgalCite{cgal:vrmls-97}, \cgalCite{cgal:hw-vrml2h-96}, +and \ref IOStreamOBJ (.obj). Another convenient output function writes a polyhedral surface to a Geomview process spawned from the \cgal program. These output functions are provided as stream operators, now acting on the stream type of the respective @@ -363,8 +358,7 @@ restrictions on these formats. They must represent a permissible polyhedral surface, e.g., a 2-manifold and no isolated vertices, see Section \ref sectionPolyIntro. -For more information, you can see the \ref IOstreamPolygonMeshIO -section. +For more information on generic polygon meshes I/O, see the section \ref IOstreamPolygonMeshIO. \section PolyhedronExtending Extending Vertices, Halfedges, and Facets diff --git a/Stream_support/doc/Stream_support/IOstream.txt b/Stream_support/doc/Stream_support/IOstream.txt index 84ea67aee17..5be16c874d3 100644 --- a/Stream_support/doc/Stream_support/IOstream.txt +++ b/Stream_support/doc/Stream_support/IOstream.txt @@ -435,8 +435,10 @@ Free functions are provided for reading and writing several \cgal types using th - `CGAL::Polygon_with_holes_2` - random access range of the above types. -You can find more information about WKT \ref PkgStreamSupportRef "here", but -here is a table to summarize the most useful functions : +You can find more information about WKT \ref PkgStreamSupportRef "here". +The following table summarizes the most useful functions. Note that the name deviates +from the standard \cgal I/O functions, for clarity reasons. +