Standardize "I/O" vs "IO"

This commit is contained in:
Mael Rouxel-Labbé 2020-07-17 10:51:01 +02:00
parent 2d51d86787
commit a53d72b986
6 changed files with 23 additions and 23 deletions

View File

@ -7,25 +7,25 @@
Collection of algorithms of point set processing (smoothing, Collection of algorithms of point set processing (smoothing,
simplification, etc.). simplification, etc.).
\defgroup PkgPointSetProcessing3IO IO (I/O Functions) \defgroup PkgPointSetProcessing3IO I/O Functions
\ingroup PkgPointSetProcessing3Ref \ingroup PkgPointSetProcessing3Ref
\defgroup PkgPointSetProcessing3IODeprecated IO (I/O Functions (Deprecated)) \defgroup PkgPointSetProcessing3IODeprecated I/O Functions (Deprecated)
\ingroup PkgPointSetProcessing3IO \ingroup PkgPointSetProcessing3IO
\defgroup PkgPointSetProcessing3IOOff IO (OFF Formats) \defgroup PkgPointSetProcessing3IOOff I/O (OFF Formats)
\ingroup PkgPointSetProcessing3Ref \ingroup PkgPointSetProcessing3Ref
\defgroup PkgPointSetProcessing3IOXyz IO (XYZ Formats) \defgroup PkgPointSetProcessing3IOXyz I/O (XYZ Formats)
\ingroup PkgPointSetProcessing3Ref \ingroup PkgPointSetProcessing3Ref
\defgroup PkgPointSetProcessing3IOPly IO (PLY Format) \defgroup PkgPointSetProcessing3IOPly I/O (PLY Format)
\ingroup PkgPointSetProcessing3Ref \ingroup PkgPointSetProcessing3Ref
Read and write points (with or without additional properties) in PLY Read and write points (with or without additional properties) in PLY
format. format.
\defgroup PkgPointSetProcessing3IOLas IO (LAS Format) \defgroup PkgPointSetProcessing3IOLas I/O (LAS Format)
\ingroup PkgPointSetProcessing3Ref \ingroup PkgPointSetProcessing3Ref
Read and write points (with or without additional properties) in LAS Read and write points (with or without additional properties) in LAS
@ -78,17 +78,17 @@ format.
- `CGAL::vcm_is_on_feature_edge()` - `CGAL::vcm_is_on_feature_edge()`
- `CGAL::structure_point_set()` - `CGAL::structure_point_set()`
\cgalCRPSection{IO (All Formats)} \cgalCRPSection{I/O (All Formats)}
- `CGAL::read_points()` - `CGAL::read_points()`
- `CGAL::write_points()` - `CGAL::write_points()`
\cgalCRPSection{IO (XYZ/OFF Formats)} \cgalCRPSection{I/O (XYZ/OFF Formats)}
- \link PkgPointSetProcessing3IOOff OFF I/O Functions (`read_OFF()` and `write_OFF()`)\endlink - \link PkgPointSetProcessing3IOOff OFF I/O Functions (`read_OFF()` and `write_OFF()`)\endlink
- \link PkgPointSetProcessing3IOXyz XYZ I/O Functions (`read_XYZ()` and `write_XYZ()`)\endlink - \link PkgPointSetProcessing3IOXyz XYZ I/O Functions (`read_XYZ()` and `write_XYZ()`)\endlink
\cgalCRPSection{IO (PLY Format)} \cgalCRPSection{I/O (PLY Format)}
- \link PkgPointSetProcessing3IOPly `CGAL::read_PLY()` \endlink - \link PkgPointSetProcessing3IOPly `CGAL::read_PLY()` \endlink
- `CGAL::read_PLY_with_properties()` - `CGAL::read_PLY_with_properties()`
@ -100,7 +100,7 @@ format.
- `CGAL::make_ply_normal_reader()` - `CGAL::make_ply_normal_reader()`
- `CGAL::make_ply_normal_writer()` - `CGAL::make_ply_normal_writer()`
\cgalCRPSection{IO (LAS Format)} \cgalCRPSection{I/O (LAS Format)}
- `CGAL::read_LAS()` - `CGAL::read_LAS()`
- `CGAL::read_LAS_with_properties()` - `CGAL::read_LAS_with_properties()`

View File

@ -2886,7 +2886,7 @@ QString make_fullpath(const QString& filename, bool duplicate = false)
} }
/* /*
The two following functions allow to create files from string and strings from files. The two following functions allow to create files from string and strings from files.
This is used as a workaround of the absence of stream management in our IO system. This is used as a workaround of the absence of stream management in our I/O system.
The whole to/from Base64 is used to avoid problems with binary formats. Everything is written The whole to/from Base64 is used to avoid problems with binary formats. Everything is written
as a base64 binary string, and converted back to what it was. as a base64 binary string, and converted back to what it was.
*/ */

View File

@ -82,9 +82,9 @@ public:
MainWindow(const QStringList& keywords, bool verbose = false,QWidget* parent = 0); MainWindow(const QStringList& keywords, bool verbose = false,QWidget* parent = 0);
~MainWindow(); ~MainWindow();
/*! Finds an IO plugin. /*! Finds an I/O plugin.
* throws std::invalid_argument if no loader with that argument can be found * throws std::invalid_argument if no loader with that argument can be found
@returns the IO plugin associated with `loader_name`*/ @returns the I/O plugin associated with `loader_name`*/
CGAL::Three::Polyhedron_demo_io_plugin_interface* findLoader(const QString& loader_name) const; CGAL::Three::Polyhedron_demo_io_plugin_interface* findLoader(const QString& loader_name) const;
/*! \brief loads on or more item with a given loader. /*! \brief loads on or more item with a given loader.

View File

@ -12,7 +12,7 @@ namespace CGAL {
An algorithm is the application of a serie of steps to convert some input data into output data. An algorithm is the application of a serie of steps to convert some input data into output data.
As such, it is necessary to have a way to input and output external data into \cgal data structures. As such, it is necessary to have a way to input and output external data into \cgal data structures.
This is achieved using <em>input-output (IO) streams</em> of data, which enables reading and writing This is achieved using <em>input/output (I/O) streams</em> of data, which enables reading and writing
to and from files, the console, or other custom structures. to and from files, the console, or other custom structures.
\subsection StreamSupportOutline Outline \subsection StreamSupportOutline Outline
@ -30,8 +30,8 @@ to and from files, the console, or other custom structures.
\section IOstreamIO Reading and Writing Data With Streams \section IOstreamIO Reading and Writing Data With Streams
All classes in the \cgal kernel provide input and output operators for All classes in the \cgal kernel provide input and output operators for
%IO streams. Classes external to \cgal are also supported, by means of `oformat()` I/O streams. Classes external to \cgal are also supported, by means of `oformat()`
(Section \ref seciofornoncgaltypes "IO for Non CGAL Types"). (Section \ref seciofornoncgaltypes "I/O for Non CGAL Types").
The basic task of such an operator is to produce a The basic task of such an operator is to produce a
representation of an object that can be written as a sequence of representation of an object that can be written as a sequence of
characters on devices as a console, a file, or a pipe. In \cgal we distinguish between a raw ascii, characters on devices as a console, a file, or a pipe. In \cgal we distinguish between a raw ascii,
@ -55,7 +55,7 @@ would be `PointC2(0.0, 0.0)`. At the moment \cgal does not
provide input operations for pretty printed data. By default a stream provide input operations for pretty printed data. By default a stream
is in <span class="textsc">Ascii</span> mode. is in <span class="textsc">Ascii</span> mode.
\cgal provides the following functions to modify the mode of an IO stream. \cgal provides the following functions to modify the mode of an I/O stream.
\code{.cpp} \code{.cpp}
IO::Mode set_mode(std::ios& s, IO::Mode m); IO::Mode set_mode(std::ios& s, IO::Mode m);

View File

@ -1,4 +1,4 @@
/// \defgroup PkgStreamSupportRef IO Streams Reference /// \defgroup PkgStreamSupportRef I/O Streams Reference
/// \defgroup IOstreamOperators Stream Operators /// \defgroup IOstreamOperators Stream Operators
/// \ingroup PkgStreamSupportRef /// \ingroup PkgStreamSupportRef
/// \defgroup IOstreamFunctions I/O Functions /// \defgroup IOstreamFunctions I/O Functions
@ -41,11 +41,11 @@
/*! /*!
\addtogroup PkgStreamSupportRef \addtogroup PkgStreamSupportRef
\cgalPkgDescriptionBegin{IO Streams,PkgStreamSupport} \cgalPkgDescriptionBegin{I/O Streams,PkgStreamSupport}
\cgalPkgPicture{io.png} \cgalPkgPicture{io.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Andreas Fabri, Geert-Jan Giezeman, and Lutz Kettner} \cgalPkgAuthors{Andreas Fabri, Geert-Jan Giezeman, and Lutz Kettner}
\cgalPkgDesc{All classes in the \cgal kernel provide input and output operators for IO streams. The basic task of such an operator is to produce a representation of an object that can be written as a sequence of characters on devices as a console, a file, or a pipe. In \cgal we distinguish between a raw ascii, a raw binary and a pretty printing format.} \cgalPkgDesc{All classes in the \cgal kernel provide input and output operators for I/O streams. The basic task of such an operator is to produce a representation of an object that can be written as a sequence of characters on devices as a console, a file, or a pipe. In \cgal we distinguish between a raw ascii, a raw binary and a pretty printing format.}
\cgalPkgManuals{Chapter_IO_Streams,PkgStreamSupportRef} \cgalPkgManuals{Chapter_IO_Streams,PkgStreamSupportRef}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
@ -56,7 +56,7 @@
\cgalPkgDescriptionEnd \cgalPkgDescriptionEnd
All classes in the \cgal kernel provide input and output operators for All classes in the \cgal kernel provide input and output operators for
IO streams. I/O streams.
\cgal provides three different printing mode, defined in the enum \cgal provides three different printing mode, defined in the enum
`IO::Mode`, as well as different functions to set and get `IO::Mode`, as well as different functions to set and get
the printing mode. the printing mode.

View File

@ -272,9 +272,9 @@ You also have the possibility to "lock" a child of a group with `CGAL::Three::Sc
\snippet Three_examples/Basic_item_plugin.cpp group \snippet Three_examples/Basic_item_plugin.cpp group
\section exampleIOPlugin Creating an IO Plugin \section exampleIOPlugin Creating an I/O Plugin
An IO plugin is a plugin desined to load from and save to a certain type of file. Its name is generally of the form Xxxx_yyyy_io_plugin \n An I/O plugin is a plugin desined to load from and save to a certain type of file. Its name is generally of the form Xxxx_yyyy_io_plugin \n
It inherits from the CGAL::Three::Polyhedron_demo_io_plugin_interface. It must implement the following functions : It inherits from the CGAL::Three::Polyhedron_demo_io_plugin_interface. It must implement the following functions :
- CGAL::Three::Polyhedron_demo_io_plugin_interface#name which returns the plugin's name. - CGAL::Three::Polyhedron_demo_io_plugin_interface#name which returns the plugin's name.
~~~~~~~~~~~~~{.cpp} ~~~~~~~~~~~~~{.cpp}