[#226] Fixed some doxygen errors

diff --git a/src/lib/asiolink/io_service.cc b/src/lib/asiolink/io_service.cc
index 919ce6e143dd24ee2dc400c4ef7f348b21960a6f..9df72e15f31bbb31a921379be6353a954ed03a89 100644 (file)
--- a/src/lib/asiolink/io_service.cc
+++ b/src/lib/asiolink/io_service.cc
@@ -69,7 +69,7 @@ public:
     /// false this indicates that the IOService was stopped.
     ///
     /// @param wait_time_usecs wait time in microseconds.
-    /// @param[out] time_out set to true if the wait time expired
+    /// @param[out] timed_out set to true if the wait time expired
     /// without any handlers executing.
     /// timed_out parameter will be set true if the wait time elapsed.
     ///

diff --git a/src/lib/asiolink/io_service.h b/src/lib/asiolink/io_service.h
index 7dc64715a59158069b581c388d7ff9139d137df8..302ac400fd5d7a5c7cf30762075c96df4a001d4e 100644 (file)
--- a/src/lib/asiolink/io_service.h
+++ b/src/lib/asiolink/io_service.h
@@ -70,7 +70,7 @@ public:
     /// false this indicates that the IOService was stopped.
     ///
     /// @param wait_time_usecs wait time in microseconds.
-    /// @param[out] time_out set to true if the wait time expired
+    /// @param[out] timed_out set to true if the wait time expired
     /// without any handlers executing.
     /// timed_out parameter will be set true if the wait time elapsed.
     ///

diff --git a/src/lib/dhcp/classify.h b/src/lib/dhcp/classify.h
index ff421ad2d76134cc965e2572ec7f9e75f0f6bb20..3596539b50e49eb9e1d3042ddf2f68be58664d51 100644 (file)
--- a/src/lib/dhcp/classify.h
+++ b/src/lib/dhcp/classify.h
@@ -272,7 +272,7 @@ private:
 /// their hashes are equal, if two class lists are not equal their hashes
 /// are almost surely not equal.
 ///
-/// @param address A @c ClientClasses to hash.
+/// @param client_classes A @c ClientClasses to hash.
 /// @return The hash of the ClientClasses.
 
 size_t hash_value(const ClientClasses& client_classes);

diff --git a/src/lib/dhcpsrv/alloc_engine.h b/src/lib/dhcpsrv/alloc_engine.h
index 1dfe8ed04698be3fcc9f0aedbcd4b7ebfb05f341..b12370f13bb3eb9280c5d2d243643d6d6e623d88 100644 (file)
--- a/src/lib/dhcpsrv/alloc_engine.h
+++ b/src/lib/dhcpsrv/alloc_engine.h
@@ -816,8 +816,8 @@ public:
     ///
     /// @param ctx client context that passes all necessary information. See
     ///        @ref ClientContext6 for details.
-    /// @param [out] preferred set to the preferred lifetime that should be used.
-    /// @param [out] valid set to the valid lifetime that should be used.
+    /// @param[out] preferred set to the preferred lifetime that should be used.
+    /// @param[out] valid set to the valid lifetime that should be used.
     static void getLifetimes6(ClientContext6& ctx, uint32_t& preferred,
                               uint32_t& valid);
 
@@ -830,10 +830,10 @@ public:
     ///
     /// @param ctx client context that passes all necessary information. See
     ///        @ref ClientContext6 for details.
-    /// @param [in/out] preferred set to the preferred lifetime that should
-    //                  be used. Caller must set it to 0 or remaining value.
-    /// @param [in/out] valid set to the valid lifetime that should be used.
-    ///                 Caller must set it to 0 or remaining value.
+    /// @param[in,out] preferred set to the preferred lifetime that should
+    ///                be used. Caller must set it to 0 or remaining value.
+    /// @param[in,out] valid set to the valid lifetime that should be used.
+    ///                Caller must set it to 0 or remaining value.
     static void getMinLifetimes6(ClientContext6& ctx, uint32_t& preferred,
                                  uint32_t& valid);
 private:
@@ -850,7 +850,7 @@ private:
     ///        available
     /// @param prefix_len length of the prefix (for PD only)
     ///        should be 128 for other lease types
-    /// @param [out] callout_status callout returned by the lease6_select
+    /// @param[out] callout_status callout returned by the lease6_select
     ///
     /// The following fields of the ctx structure are used:
     /// @ref ClientContext6::subnet_ Subnet the lease is allocated from
@@ -1564,9 +1564,8 @@ public:
     /// remaining lifetime is returned when greater than minimal.
     ///
     /// @param ctx Client context holding various information about the client.
-    /// @param [in/out] valid set to the valid lifetime that should be used.
-    ///                 Caller must set it to 0 or remaining value.
-    /// @return unsigned integer value of the valid lifetime to use.
+    /// @param[in,out] valid set to the valid lifetime that should be used.
+    ///                Caller must set it to 0 or remaining value.
     static void getMinValidLft(const ClientContext4& ctx, uint32_t& valid);
 
     /// @brief Returns the offer lifetime based on the v4 context