Author: mordante
Date: Sat Sep 20 09:53:35 2008
New Revision: 29565
URL: http://svn.gna.org/viewcvs/wesnoth?rev=29565&view=rev
Log:
Update doxygen comment style.
Modified:
trunk/src/gui/widgets/settings.cpp
trunk/src/gui/widgets/settings.hpp
Modified: trunk/src/gui/widgets/settings.cpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/gui/widgets/settings.cpp?rev=29565&r1=29564&r2=29565&view=diff
==============================================================================
--- trunk/src/gui/widgets/settings.cpp (original)
+++ trunk/src/gui/widgets/settings.cpp Sat Sep 20 09:53:35 2008
@@ -12,8 +12,10 @@
See the COPYING file for more details.
*/
-//! @file setting.cpp
-//! Implementation of settings.hpp.
+/**
+ * @file setting.cpp
+ * Implementation of settings.hpp.
+ */
#include "gui/widgets/settings.hpp"
@@ -67,17 +69,19 @@
namespace {
- //! Map with all known windows, (the builder class builds a window).
+ /** Map with all known windows, (the builder class builds a window). */
std::map<std::string, twindow_builder> windows;
- //! Map with all known guis.
+ /** Map with all known guis. */
std::map<std::string, tgui_definition> guis;
- //! Points to the current gui.
+ /** Points to the current gui. */
std::map<std::string, tgui_definition>::const_iterator current_gui =
guis.end();
- //! Vector with all known windows, these are validated on existance on
startup.
- //! The enum twindow_type is the index of the array.
+ /**
+ * Vector with all known windows, these are validated on existance on
startup.
+ * The enum twindow_type is the index of the array.
+ */
std::vector<std::string> window_type_list(DUMMY);
} // namespace
Modified: trunk/src/gui/widgets/settings.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/gui/widgets/settings.hpp?rev=29565&r1=29564&r2=29565&view=diff
==============================================================================
--- trunk/src/gui/widgets/settings.hpp (original)
+++ trunk/src/gui/widgets/settings.hpp Sat Sep 20 09:53:35 2008
@@ -12,8 +12,10 @@
See the COPYING file for more details.
*/
-//! @file setting.hpp
-//! This file contains the settings handling of the widget library.
+/**
+ * @file setting.hpp
+ * This file contains the settings handling of the widget library.
+ */
#ifndef GUI_WIDGETS_SETTING_HPP_INCLUDED
#define GUI_WIDGETS_SETTING_HPP_INCLUDED
@@ -35,28 +37,33 @@
enum twindow_type {
TITLE_SCREEN, /**< The main title screen of the game. */
- ADDON_CONNECT, //<! The addon server connection dialog.
- LANGUAGE_SELECTION, //<! The language selection dialog.
- MP_CONNECT, //<! The mp server connection dialog.
- MP_METHOD_SELECTION, //<! The dialog which allows you to choose the
kind
- //! mp game the user wants to play.
- MP_SERVER_LIST, //<! The mp server list dialog.
+ ADDON_CONNECT, /**< The addon server connection dialog. */
+ LANGUAGE_SELECTION, /**< The language selection dialog. */
+ MP_CONNECT, /**< The mp server connection dialog. */
+ MP_METHOD_SELECTION, /**<
+ * The dialog which allows you to choose the
kind
+ * mp game the user wants to play.
+ */
+ MP_SERVER_LIST, /**< The mp server list dialog. */
MP_CREATE_GAME, /**< The mp creation dialog. */
#ifndef DISABLE_EDITOR2
- EDITOR_NEW_MAP, //<! New map dialog
- EDITOR_GENERATE_MAP, /** Editor random map genarator dialog */
- EDITOR_RESIZE_MAP, /** Editor resize map dialog */
- EDITOR_SETTINGS, /** Editor settings dialog */
+ EDITOR_NEW_MAP, /**< New map dialog. */
+ EDITOR_GENERATE_MAP, /**< Editor random map genarator dialog. */
+ EDITOR_RESIZE_MAP, /**< Editor resize map dialog. */
+ EDITOR_SETTINGS, /**< Editor settings dialog. */
#endif
- DUMMY //<! Dummy always the last one.
+ DUMMY /**< Dummy always the last one. */
};
const std::string& get_id(const twindow_type window_type);
-//! Contains the state info for a resolution.
-//! Atm all states are the same so there is no need to use inheritance. If that
-//! is needed at some point the containers should contain pointers and we
should
-//! inherit from reference_counted_object.
+/**
+ * Contains the state info for a resolution.
+ *
+ * At the moment all states are the same so there is no need to use
+ * inheritance. If that is needed at some point the containers should contain
+ * pointers and we should inherit from reference_counted_object.
+ */
struct tstate_definition
{
private:
@@ -71,7 +78,7 @@
};
-//! Base class of a resolution, contains the common keys for a resolution.
+/** Base class of a resolution, contains the common keys for a resolution. */
struct tresolution_definition_ : public reference_counted_object
{
private:
@@ -338,7 +345,7 @@
const std::string& read(const config& cfg);
- //! Activates a gui.
+ /** Activates a gui. */
void activate() const;
typedef std::map <std::string /*control type*/,
@@ -367,18 +374,21 @@
std::vector<twindow_builder::tresolution>::const_iterator
get_window_builder(const std::string& type);
- //! Loads the setting for the theme.
+ /** Loads the setting for the theme. */
void load_settings();
- // This namespace contains the 'global' settings.
+ /** This namespace contains the 'global' settings. */
namespace settings {
- //! The screen resolution should be available for all widgets
since their
- //! drawing method will depend on it.
+
+ /**
+ * The screen resolution should be available for all widgets
since
+ * their drawing method will depend on it.
+ */
extern unsigned screen_width;
extern unsigned screen_height;
- //! These are copied from the active gui.
+ /** These are copied from the active gui. */
extern unsigned popup_show_delay;
extern unsigned popup_show_time;
extern unsigned help_show_time;
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
