cgal/Stream_support/doc/IOstream/PackageDescription.txt

25 lines
1.0 KiB
Plaintext

/// \defgroup PkgIOstreams IO Streams Reference
/*!
\addtogroup PkgIOstreams
\cgalPkgDescriptionBegin{IO Streams,PkgIOstreamsSummary}
\cgalPkgPicture{io.png}
\cgalPkgSummaryBegin
\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.}
\cgalPkgManuals{Chapter_IO_Streams,PkgIOstreams}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{1.0}
\cgalPkgBib{cgal:fgk-ios-12}
\cgalPkgLicense{\ref licensesLGPL "LGPL"}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
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.
*/