Author: mordante
Date: Sat Sep 20 11:44:02 2008
New Revision: 29572
URL: http://svn.gna.org/viewcvs/wesnoth?rev=29572&view=rev
Log:
Update doxygen comment style.
Modified:
trunk/src/serialization/binary_wml.hpp
Modified: trunk/src/serialization/binary_wml.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/serialization/binary_wml.hpp?rev=29572&r1=29571&r2=29572&view=diff
==============================================================================
--- trunk/src/serialization/binary_wml.hpp (original)
+++ trunk/src/serialization/binary_wml.hpp Sat Sep 20 11:44:02 2008
@@ -23,7 +23,7 @@
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
{
compression_schema() : char_to_word(), word_to_char() { }
@@ -37,13 +37,17 @@
// Read and write compressed data.
-//! Write compressed data.
-//! The schema will be created and written with the 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, meaning that the entire schema won't have to be transmitted
each time.
+/**
+ * Write compressed data.
+ *
+ * The schema will be created and written with the 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,
+ * 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);
-//! Read compressed data.
+
+/** Read compressed data. */
void read_compressed(config &cfg, std::istream &in, compression_schema
&schema); //throws config::error
void write_compressed(std::ostream &out, config const &cfg);
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
