[lmi-commits] [lmi] master 6f44918 2/3: Use doxygen style for function comments

[Greg Chicares]

branch: master
commit 6f449180dc3ad6014c9fc56a25e6c1f355726b7a
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Use doxygen style for function comments
    
    Comments quoted from the doxygen-1.8.12 documentation:
    
    /// C++ comment lines, where each line starts with an additional slash
    /// Note that a blank line ends a documentation block in this case.
    
    void function_to_be_documented()
---
 rate_table_tool.cpp |   11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/rate_table_tool.cpp b/rate_table_tool.cpp
index e8241d6..99e7c31 100644
--- a/rate_table_tool.cpp
+++ b/rate_table_tool.cpp
@@ -71,7 +71,8 @@ void calculate_and_display_crcs(fs::path const& 
database_filename)
         }
 }
 
-// Return a sorted vector of all table numbers.
+/// Return a sorted vector of all table numbers.
+
 std::vector<table::Number> get_all_tables_numbers(database const& table_file)
 {
     int const tables_count = table_file.tables_count();
@@ -162,8 +163,9 @@ void delete_table
     table_file.save(database_filename);
 }
 
-// Save the given table in a text file with its number as name, return the name
-// of this file.
+/// Save the given table in a text file with its number as name;
+/// return the name of this file.
+
 std::string do_save_as_text_file(table const& t)
 {
     std::ostringstream oss;
@@ -298,7 +300,8 @@ void rename_tables
     table_file.save(database_filename);
 }
 
-// Returns the number of tables that failed the verification.
+/// Return the number of tables that failed verification.
+
 int verify(fs::path const& database_filename)
 {
     database const orig_db(database_filename);