From 0fd8bbf920208b61992757a11b9237cec1c9afe9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Fri, 26 Jun 2020 16:21:09 +0200 Subject: [PATCH] Re-add doc of operator<<(stream, Class) in io.h --- Stream_support/include/CGAL/IO/io.h | 42 +++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/Stream_support/include/CGAL/IO/io.h b/Stream_support/include/CGAL/IO/io.h index 80de620f4ea..70465314fea 100644 --- a/Stream_support/include/CGAL/IO/io.h +++ b/Stream_support/include/CGAL/IO/io.h @@ -82,6 +82,48 @@ enum Mode {ASCII = 0, PRETTY, BINARY}; } // namespace IO +#ifdef DOXYGEN_RUNNING +/*! +\ingroup IOstreamOperators + +\brief Inserts object `c` in the stream `os`. Returns `os`. +\cgal defines output operators for classes that are derived +from the class `ostream`. This allows to write to ostreams +as `cout` or `cerr`, as well as to `std::ostringstream` +and `std::ofstream`. +The output operator is defined for all classes in the \cgal `Kernel` and for the class `Color` as well. + +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` +*/ +ostream& operator<<(ostream& os, Class c); + +/*! +\ingroup IOstreamOperators + +\brief \cgal defines input operators for classes that are derived +from the class `istream`. This allows to read from istreams +as `std::cin`, as well as from `std::istringstream` and `std::ifstream`. +The input operator is defined for all classes in the \cgal `Kernel`. + +\sa `CGAL::set_mode()` +\sa `CGAL::set_ascii_mode()` +\sa `CGAL::set_binary_mode()` +\sa `CGAL::set_pretty_mode()` +\sa `CGAL::get_mode()` +\sa `CGAL::is_ascii()` +\sa `CGAL::is_binary()` +\sa `CGAL::is_pretty()` +*/ +istream& operator>>(istream& is, Class c); +#endif + template struct IO_rep_is_specialized_aux {