mail[Wesnoth-commits] r29059 - in /trunk/src: addon_management.cpp addon_management.hpp


Others Months | Index by Date | Thread Index
>>   [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Header


Content

Posted by koraq on August 28, 2008 - 19:24:
Author: mordante
Date: Thu Aug 28 19:24:20 2008
New Revision: 29059

URL: http://svn.gna.org/viewcvs/wesnoth?rev=29059&view=rev
Log:
Update doxygen comment style.

Modified:
    trunk/src/addon_management.cpp
    trunk/src/addon_management.hpp

Modified: trunk/src/addon_management.cpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/addon_management.cpp?rev=29059&r1=29058&r2=29059&view=diff
==============================================================================
--- trunk/src/addon_management.cpp (original)
+++ trunk/src/addon_management.cpp Thu Aug 28 19:24:20 2008
@@ -296,10 +296,13 @@
 }
 
 namespace {
-       //! Strip the ".cfg" extension and replace "_" with " " for display.
-       //! @param files      List of files in the add-ons directory.
-       //! @param dirs       List of subdirectories in the add-ons directory.
-       //! @param parent_dir Path to the add-ons directory.
+       /**
+        * Strip the ".cfg" extension and replace "_" with " " for display.
+        *
+        * @param files      List of files in the add-ons directory.
+        * @param dirs       List of subdirectories in the add-ons directory.
+        * @param parent_dir Path to the add-ons directory.
+        */
        void prepare_addons_list_for_display(std::vector<std::string>& files,
                                             std::vector<std::string>& dirs,
                                             const std::string& parent_dir)
@@ -337,10 +340,14 @@
                }
        }
        
-       //! Creates a more human-readable representation of a file size.
-       //! @param size_str File size string, as obtained from a config 
object.
-       //! @return         Representation of file size in the biggest byte 
multiply
-       //!                 possible.
+       /**
+        * Creates a more human-readable representation of a file size.
+        *
+        * @param size_str File size string, as obtained from a config object.
+        *
+        * @returns        Representation of file size in the biggest byte 
multiply
+        *                 possible.
+        */
        static std::string format_file_size(const std::string& size_str)
        {
                double size = lexical_cast_default<double>(size_str,0.0);
@@ -378,9 +385,13 @@
                }
        }
        
-       //! Return a short string describing an add-on's type.
-       //! @param type Numerical add-on type.
-       //! @return     A string, translated to the current locale.
+       /**
+        * Return a short string describing an add-on's type.
+        *
+        * @param type Numerical add-on type.
+        *
+        * @return     A string, translated to the current locale.
+        */
        std::string get_translatable_addon_type(ADDON_TYPE type)
        {
                switch (type) {
@@ -405,10 +416,14 @@
                }
        }
        
-       //! Checks if an add-on's dependencies are met.
-       //! @param disp    Object to be used for displaying interactive 
messages.
-       //! @param deplist List of dependencies (add-on identifiers).
-       //! @return        true if dependencies are met; false otherwise.
+       /**
+        * Checks if an add-on's dependencies are met.
+        *
+        * @param disp    Object to be used for displaying interactive 
messages.
+        * @param deplist List of dependencies (add-on identifiers).
+        *
+        * @returns       true if dependencies are met; false otherwise.
+        */
        bool addon_dependencies_met(game_display& disp, const 
std::vector<std::string>& deplist)
        {
                const std::vector<std::string>& installed = 
installed_addons();

Modified: trunk/src/addon_management.hpp
URL: 
http://svn.gna.org/viewcvs/wesnoth/trunk/src/addon_management.hpp?rev=29059&r1=29058&r2=29059&view=diff
==============================================================================
--- trunk/src/addon_management.hpp (original)
+++ trunk/src/addon_management.hpp Thu Aug 28 19:24:20 2008
@@ -59,15 +59,17 @@
 /** Unarchives an add-on from campaignd's retrieved config object. */
 void unarchive_addon(const class config& cfg);
 
-/** Shows the game add-ons manager dialog.
- *  @param disp game_display instance to draw on.
+/** 
+ * Shows the game add-ons manager dialog.
+ *
+ * @param disp game_display instance to draw on.
  */
 void manage_addons(class game_display& disp);
 
-//! Refreshes the per-session cache of add-on's version
-//! information structs.
+/** Refreshes the per-session cache of add-on's version information structs. 
*/
 void refresh_addon_version_info_cache();
-//! Returns a particular installed add-on's version information.
+
+/** Returns a particular installed add-on's version information. */
 const class version_info& get_addon_version_info(const std::string& addon);
 
 #endif /* !ADDON_MANAGEMENT_HPP_INCLUDED */




Related Messages


Powered by MHonArc, Updated Thu Aug 28 19:41:03 2008