cgal/Stream_support/doc/IOstream/PackageDescription.txt

22 lines
974 B
Plaintext

/// \defgroup PkgIOstreams IO Streams Reference
/*!
\addtogroup PkgIOstreams
\todo check generated documentation
\PkgDescriptionBegin{IO Streams,PkgIOstreamsSummary}
\PkgPicture{io.png}
\PkgAuthor{Andreas Fabri, Geert-Jan Giezeman, and Lutz Kettner}
\PkgDesc{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.}
\PkgSince{1.0}
\PkgBib{cgal:fgk-ios-12}
\PkgLicense{\ref licensesLGPL "LGPL"}
\PkgManuals{Chapter_IO_Streams,PkgIOstreams}
\PkgDescriptionEnd
All classes in the \cgal kernel provide input and output operators for
IO streams.
\cgal provides three different printing mode, defined in the enum
`Mode`, as well as different functions to set and get
the printing mode.
*/