upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2025-05-07 12:54:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update doxygen comment style.

Browse Source
This commit is contained in:
Mark de Wever 2008-09-20 09:44:02 +00:00
parent ec87c3da3f
commit 23f5b13eb1
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/serialization/binary_wml.hpp
View File

@ -23,7 +23,7 @@
class config; class config;
//! Holds the schema by which config objects can be compressed and decompressed. /** Holds the schema by which config objects can be compressed and decompressed. */
struct compression_schema struct compression_schema
{ {
compression_schema() : char_to_word(), word_to_char() { } compression_schema() : char_to_word(), word_to_char() { }
@ -37,13 +37,17 @@ struct compression_schema
// Read and write compressed data. // Read and write compressed data.
//! Write compressed data. /**
//! The schema will be created and written with the data. * Write compressed data.
//! However if you are making successive writes (e.g. a network connection), *
//! you can re-use the same schema on the sending end, and the receiver can store * The schema will be created and written with the data. However if you are
//! the schema, meaning that the entire schema won't have to be transmitted each time. * making successive writes (e.g. a network connection), you can re-use the
* same schema on the sending end, and the receiver can store the schema,
* meaning that the entire schema won't have to be transmitted each time.
*/
void write_compressed(std::ostream &out, config const &cfg, compression_schema &schema); void write_compressed(std::ostream &out, config const &cfg, compression_schema &schema);
//! Read compressed data.
/** Read compressed data. */
void read_compressed(config &cfg, std::istream &in, compression_schema &schema); //throws config::error void read_compressed(config &cfg, std::istream &in, compression_schema &schema); //throws config::error
void write_compressed(std::ostream &out, config const &cfg); void write_compressed(std::ostream &out, config const &cfg);