Author: mordante
Date: Sat Sep 20 11:44:36 2008
New Revision: 29576
URL: http://svn.gna.org/viewcvs/wesnoth?rev=29576&view=rev
Log:
Update doxygen comment style.
Modified:
trunk/src/serialization/binary_or_text.cpp
trunk/src/serialization/binary_or_text.hpp
Modified: trunk/src/serialization/binary_or_text.cpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/serialization/binary_or_text.cpp?rev=29576&r1=29575&r2=29576&view=diff
==============================================================================
--- trunk/src/serialization/binary_or_text.cpp (original)
+++ trunk/src/serialization/binary_or_text.cpp Sat Sep 20 11:44:36 2008
@@ -13,8 +13,10 @@
See the COPYING file for more details.
*/
-//! @file serialization/binary_or_text.cpp
-//! Read/Write file in binary (compressed) or text-format (uncompressed).
+/**
+ * @file serialization/binary_or_text.cpp.
+ * Read/Write file in binary (compressed) or text-format (uncompressed).
+ */
#include "global.hpp"
Modified: trunk/src/serialization/binary_or_text.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/serialization/binary_or_text.hpp?rev=29576&r1=29575&r2=29576&view=diff
==============================================================================
--- trunk/src/serialization/binary_or_text.hpp (original)
+++ trunk/src/serialization/binary_or_text.hpp Sat Sep 20 11:44:36 2008
@@ -13,8 +13,7 @@
See the COPYING file for more details.
*/
-//! @file serialization/binary_or_text.hpp
-//!
+/** @file serialization/binary_or_text.hpp. */
#ifndef SERIALIZATION_BINARY_OR_TEXT_HPP_INCLUDED
#define SERIALIZATION_BINARY_OR_TEXT_HPP_INCLUDED
@@ -27,16 +26,21 @@
#include <boost/iostreams/filtering_stream.hpp>
class config;
-//! Reads a file, and detects it is compressed before reading it.
-//! If it is not a valid file at all, it will throw an error
-//! as if it was trying to read it as text WML.
-//! Returns true iff the format is compressed.
+
+/**
+ * Reads a file, and detects it is compressed before reading it.
+ *
+ * If it is not a valid file at all, it will throw an error as if it was trying
+ * to read it as text WML.
+ *
+ * @returns True iff the format is compressed.
+ */
bool detect_format_and_read(config &cfg, std::istream &in, std::string*
error_log=NULL); // Throws config::error
-//! Writes a file, compressed or not depending on a flag.
+/** Writes a file, compressed or not depending on a flag. */
void write_possibly_compressed(std::ostream &out, config &cfg, bool compress);
-//! Class for writing a config out to a file in pieces.
+/** Class for writing a config out to a file in pieces. */
class config_writer
{
public:
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
