Browse Source

[3665] Trivial: cleanup of the doxygen for lfc.

Marcin Siodelski 10 years ago
parent
commit
a0705dc5c2
2 changed files with 14 additions and 12 deletions
  1. 13 10
      src/bin/lfc/lfc_controller.h
  2. 1 2
      src/lib/dhcpsrv/lease_file_loader.h

+ 13 - 10
src/bin/lfc/lfc_controller.h

@@ -59,10 +59,11 @@ public:
     ~LFCController();
 
     /// @brief Acts as the primary entry point to start execution
-    /// of the process.  Provides the control logic to combine
-    /// two lease files and weed out duplicate and expired leases.
-    /// A description of the design can be found at
-    /// http://kea.isc.org/wiki/LFCDesign
+    /// of the process.
+    ///
+    ///Provides the control logic to combine two lease files and
+    /// weed out duplicate and expired leases. A description of
+    /// the design can be found at http://kea.isc.org/wiki/LFCDesign
     ///
     /// -# parse command line arguments
     /// -# verify that it is the only instance
@@ -80,8 +81,9 @@ public:
     /// @throw InvalidUsage if the command line parameters are invalid.
     void launch(int argc, char* argv[]);
 
-    /// @brief Process the command line arguments.  It is the first
-    /// step taken after the process has been launched.
+    /// @brief Process the command line arguments.
+    ///
+    /// It is the first step taken after the process has been launched.
     ///
     /// @param argc Number of strings in the @c argv array.
     /// @param argv Array of arguments passed in via the program's main function.
@@ -89,10 +91,11 @@ public:
     /// @throw InvalidUsage if the command line parameters are invalid.
     void parseArgs(int argc, char* argv[]);
 
-    /// @brief Rotate files.  After we have a finish file, either from
-    /// doing the cleanup or because a previous instance was interrupted,
-    /// delete the work files (previous & copy) and move the finish file
-    /// to be the new previous file.
+    /// @brief Rotate files.
+    ///
+    /// After we have a finish file, either from doing the cleanup or because
+    /// a previous instance was interrupted, delete the work files (previous
+    /// & copy) and move the finish file to be the new previous file.
     ///
     /// @throw RunTimeFail if we can't manipulate the files.
     void fileRotate() const;

+ 1 - 2
src/lib/dhcpsrv/lease_file_loader.h

@@ -183,11 +183,10 @@ public:
     /// doesn't need to be open because the method re-opens the file.
     /// @param storage A reference to the container from which leases
     /// should be written.
+    ///
     /// @tparam LeasePtrType A @c Lease4 or @c Lease6.
     /// @tparam LeaseFileType A @c CSVLeaseFile4 or @c CSVLeaseFile6.
     /// @tparam StorageType A @c Lease4Storage or @c Lease6Storage.
-    ///
-
     template<typename LeaseObjectType, typename LeaseFileType,
              typename StorageType>
     static void write(LeaseFileType& lease_file, const StorageType& storage) {