Author: mordante
Date: Sun May 18 15:47:04 2008
New Revision: 26690
URL: http://svn.gna.org/viewcvs/wesnoth?rev=26690&view=rev
Log:
Update doxygen comment style.
Modified:
trunk/src/wml_exception.cpp
trunk/src/wml_exception.hpp
Modified: trunk/src/wml_exception.cpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/wml_exception.cpp?rev=26690&r1=26689&r2=26690&view=diff
==============================================================================
--- trunk/src/wml_exception.cpp (original)
+++ trunk/src/wml_exception.cpp Sun May 18 15:47:04 2008
@@ -12,8 +12,10 @@
See the COPYING file for more details.
*/
-//! @file wml_exception.cpp
-//! Implementation for wml_exception.hpp.
+/**
+ * @file wml_exception.cpp
+ * Implementation for wml_exception.hpp.
+ */
#include "global.hpp"
#include "wml_exception.hpp"
@@ -25,13 +27,6 @@
#include <cassert>
#include <sstream>
-//! Helper function, don't call this directly.
-//!
-//! @param cond The textual presentation of the test that failed.
-//! @param file The file in which the test failed.
-//! @param line The line at which the test failed.
-//! @param function The funtion in which the test failed.
-//! @param message The translatable message to show the user.
void wml_exception(const char* cond, const char* file,
const int line, const char* function, const t_string& message)
{
@@ -48,9 +43,6 @@
{
}
-//! Shows the error in a dialog.
-//!
-//! @param disp The display object to show the message on.
void twml_exception::show(display &disp)
{
std::stringstream sstr;
@@ -65,16 +57,6 @@
gui::show_error_message(disp, sstr.str());
}
-//! Returns a standard message for a missing wml key.
-//!
-//! @param section The section is which the key should appear.
-//! @param key The ommitted key.
-//! @param primary_key The primary key of the section.
-//! @param primary_value
-//! The value of the primary key (mandatory if primary key
-//! isn't empty).
-//!
-//! @return The error message.
t_string missing_mandatory_wml_key(const std::string& section, const
std::string& key,
const std::string& primary_key, const std::string&
primary_value)
{
Modified: trunk/src/wml_exception.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/wml_exception.hpp?rev=26690&r1=26689&r2=26690&view=diff
==============================================================================
--- trunk/src/wml_exception.hpp (original)
+++ trunk/src/wml_exception.hpp Sun May 18 15:47:04 2008
@@ -12,9 +12,11 @@
See the COPYING file for more details.
*/
-//! @file wml_exception.hpp
-//! Add a special kind of assert to validate whether the input from WML
-//! doesn't contain any problems that might crash the game.
+/**
+ * @file wml_exception.hpp
+ * Add a special kind of assert to validate whether the input from WML
+ * doesn't contain any problems that might crash the game.
+ */
#ifndef WML_EXCEPTION_HPP_INCLUDED
#define WML_EXCEPTION_HPP_INCLUDED
@@ -25,10 +27,12 @@
class display;
-//! The macro to use for the validation of WML
-//!
-//! @param cond The condition to test, if false and exception is
generated.
-//! @param message The translatable message to show at the user.
+/**
+ * The macro to use for the validation of WML
+ *
+ * @param cond The condition to test, if false and exception is
generated.
+ * @param message The translatable message to show at the user.
+ */
#ifdef _MSC_VER
#if _MSC_VER < 1300
#define __FUNCTION__ "(Unspecified)"
@@ -42,43 +46,69 @@
#define VALIDATE(cond, message) if(!(cond)) wml_exception(#cond, __FILE__,
__LINE__, __FUNCTION__, message)
#endif
-//! Helper function, don't call this directly.
+/**
+ * Helper function, don't call this directly.
+ *
+ * @param cond The textual presentation of the test that failed.
+ * @param file The file in which the test failed.
+ * @param line The line at which the test failed.
+ * @param function The funtion in which the test failed.
+ * @param message The translatable message to show the user.
+ */
void wml_exception(const char* cond, const char* file,
const int line, const char* function, const t_string& message);
-//! Helper function, don't call this directly.
+/** Helper function, don't call this directly. */
inline void wml_exception(const char* cond, const char* file,
const int line, const char* function, const char* message)
{
wml_exception(cond, file, line, function, t_string(message));
}
-//! Helper function, don't call this directly.
+/** Helper function, don't call this directly. */
inline void wml_exception(const char* cond, const char* file,
const int line, const char* function, const std::string& message)
{
wml_exception(cond, file, line, function, t_string(message));
}
-//! Helper class, don't construct this directly.
+/** Helper class, don't construct this directly. */
struct twml_exception
{
twml_exception(const t_string& user_msg, const std::string& dev_msg);
-
- //! The message for the user explaining what went wrong. This message
can
- //! be translated so the user gets a explanation in his/her native
tongue.
+
+ /*
+ * The message for the user explaining what went wrong. This message
can
+ * be translated so the user gets a explanation in his/her native
tongue.
+ */
t_string user_message;
- //! The message for developers telling which problem was triggered, this
- //! shouldn't be translated. It's hard for a dev to parse errors in
- //! foreign tongues.
+ /**
+ * The message for developers telling which problem was triggered, this
+ * shouldn't be translated. It's hard for a dev to parse errors in
+ * foreign tongues.
+ */
std::string dev_message;
- //! Shows the error in a dialog.
+ /**
+ * Shows the error in a dialog.
+ * @param disp The display object to show the message on.
+ */
void show(display &disp);
};
-//! Returns a standard message for a missing wml key.
+/**
+ * Returns a standard message for a missing wml key.
+ *
+ * @param section The section is which the key should appear.
+ * @param key The ommitted key.
+ * @param primary_key The primary key of the section.
+ * @param primary_value
+ * The value of the primary key (mandatory if primary key
+ * isn't empty).
+ *
+ * @return The error message.
+ */
t_string missing_mandatory_wml_key(const std::string& section, const
std::string& key,
const std::string& primary_key = "", const std::string&
primary_value = "");
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
