[3484] Fixed quite a few doxygen warnings.

diff --git a/src/bin/dhcp4/dhcp4.dox b/src/bin/dhcp4/dhcp4.dox
index 50b47bc82b48153b72064f315bc20d1fdcbf1e0d..ce54e771e688ad779a653b74a9b4b70aa50581fd 100644 (file)
--- a/src/bin/dhcp4/dhcp4.dox
+++ b/src/bin/dhcp4/dhcp4.dox
@@ -37,7 +37,7 @@ src/lib/dhcpsrv/parsers/ directory. Parsers specific to the DHCPv4 component
 are located in the src/bin/dhcp4/json_config_parser.cc. These parsers derive
 from the common configuration parsers and customize their behavior. For
 example: the @c Subnet4ConfigParser is used to parse parameters
-describing a single subnet. It derives from the @ref
+describing a single subnet. It derives from the @c
 isc::dhcp::SubnetConfigParser, which implements the common base for both
 DHCPv4 and DHCPv6 subnets. The @ref isc::dhcp::Subnet4ConfigParser
 implements the @c initSubnet abstract method, which creates an instance of

diff --git a/src/bin/dhcp4/dhcp4_srv.h b/src/bin/dhcp4/dhcp4_srv.h
index 1a58279ea33e06539927c94083fd984f9b15e37f..d01c17c4cb3190df34aef4d00e0286e455f1574a 100644 (file)
--- a/src/bin/dhcp4/dhcp4_srv.h
+++ b/src/bin/dhcp4/dhcp4_srv.h
@@ -156,9 +156,6 @@ typedef boost::shared_ptr<Dhcpv4Exchange> Dhcpv4ExchangePtr;
 /// This class does not support any controlling mechanisms directly.
 /// See the derived \ref ControlledDhcpv4Srv class for support for
 /// command and configuration updates over msgq.
-///
-/// For detailed explanation or relations between main(), ControlledDhcpv4Srv,
-/// Dhcpv4Srv and other classes, see \ref dhcpv4Session.
 class Dhcpv4Srv : public Daemon {
 
 public:

diff --git a/src/bin/dhcp4/main.cc b/src/bin/dhcp4/main.cc
index 0635086950f4017610d417c09dc084368e80e92c..79af1e0201f85496eeef8a9c1b08a06cc92331f0 100644 (file)
--- a/src/bin/dhcp4/main.cc
+++ b/src/bin/dhcp4/main.cc
@@ -33,9 +33,6 @@ using namespace std;
 /// instantiates ControlledDhcpv4Srv class that is responsible for establishing
 /// connection with msgq (receiving commands and configuration) and also
 /// creating Dhcpv4 server object as well.
-///
-/// For detailed explanation or relations between main(), ControlledDhcpv4Srv,
-/// Dhcpv4Srv and other classes, see \ref dhcpv4Session.
 
 namespace {
 

diff --git a/src/bin/dhcp6/dhcp6.dox b/src/bin/dhcp6/dhcp6.dox
index aad0d0391eb57a91b953e810a9db7f116ffead31..f112f2797858f28e02551002e9fc1e555f45115c 100644 (file)
--- a/src/bin/dhcp6/dhcp6.dox
+++ b/src/bin/dhcp6/dhcp6.dox
@@ -37,7 +37,7 @@ src/lib/dhcpsrv/parsers/ directory. Parsers specific to the DHCPv6 component
 are located in the src/bin/dhcp6/json_config_parser.cc. These parsers derive
 from the common configuration parsers and customize their behavior. For
 example: the @c Subnet6ConfigParser is used to parse parameters
-describing a single subnet. It derives from the @ref
+describing a single subnet. It derives from the @c
 isc::dhcp::SubnetConfigParser, which implements the common base for both
 DHCPv4 and DHCPv6 subnets. The @ref isc::dhcp::Subnet6ConfigParser
 implements the @c initSubnet abstract method, which creates an instance of

diff --git a/src/bin/dhcp6/dhcp6_srv.h b/src/bin/dhcp6/dhcp6_srv.h
index bdd4169e673337ed2ee9b97a4228f1ebfa3075a9..422eff5847a277a3ca31ac3aa0c37870516dc6ad 100644 (file)
--- a/src/bin/dhcp6/dhcp6_srv.h
+++ b/src/bin/dhcp6/dhcp6_srv.h
@@ -331,8 +331,6 @@ protected:
     /// not appropriate for the link the client is attached to, the server MAY
     /// send the IA with address lifetimes set to 0 or discard the message.
     ///
-    /// @param subnet subnet the sender belongs to
-    /// @param duid client's duid
     /// @param query client's message (Renew or Rebind)
     /// @param answer server's response to the client's message. This
     /// message should contain Client FQDN option being sent by the server

diff --git a/src/lib/asiolink/io_asio_socket.h b/src/lib/asiolink/io_asio_socket.h
index afd28849a7d68e49ab4166ea894ebbc709094255..453b5f6ee2847d1278d258c8189cb00fdb1cde61 100644 (file)
--- a/src/lib/asiolink/io_asio_socket.h
+++ b/src/lib/asiolink/io_asio_socket.h
@@ -349,13 +349,7 @@ public:
 
     /// \brief Checks if the data received is complete.
     ///
-    /// \param staging Unused
-    /// \param length Unused
-    /// \param cumulative Unused
-    /// \param offset Unused.
-    /// \param expected Unused.
-    /// \param outbuff Unused.
-    ///
+    /// The parameters are unused.
     /// \return Always true
     virtual bool receiveComplete(const void*, size_t, size_t&, size_t&,
                                  size_t&, isc::util::OutputBufferPtr&)

diff --git a/src/lib/config/command-socket.dox b/src/lib/config/command-socket.dox
index c7169b854d8a5cecea685c54556cbd4893540f7e..27ecd848526b47f053ecc834a0c66b5cf78f74e6 100644 (file)
--- a/src/lib/config/command-socket.dox
+++ b/src/lib/config/command-socket.dox
@@ -185,7 +185,8 @@ or HTTPS connection):
 Control Channel is connection oriented communication. In that sense it is
 different than all other communications supported so far in Kea. To facilitate
 connections, several mechanisms were implemented. Intially a single UNIX socket
-it opened (see isc::config::UnixCommandSocket). Its @ref
+it opened (see @c isc::config::UnixCommandSocket in
+src/lib/config/command_socket_factory.cc). Its @ref
 isc::config::UnixCommandSocket::receiveHandler callback method is
 installed in @ref isc::dhcp::IfaceMgr to process incoming connections. When the
 select call in @ref isc::dhcp::IfaceMgr::receive4 indicates that there is some data to be

diff --git a/src/lib/config/command_mgr.h b/src/lib/config/command_mgr.h
index f7c3ec9497548f049c4c2a51d56b08d7b126c153..ba4f276176f12ce5d8dc9a0cb0286d4016a6bcd6 100644 (file)
--- a/src/lib/config/command_mgr.h
+++ b/src/lib/config/command_mgr.h
@@ -129,7 +129,8 @@ public:
     /// @brief Reads data from a socket, parses as JSON command and processes it
     ///
     /// This method is used to handle traffic on connected socket. This callback
-    /// is installed by the @ref isc::config::UnixCommandSocket::receiveHandler
+    /// is installed by the @c isc::config::UnixCommandSocket::receiveHandler
+    /// (located in the src/lib/config/command_socket_factory.cc)
     /// once the incoming connection is accepted. If end-of-file is detected, this
     /// method will close the socket and will uninstall itself from
     /// @ref isc::dhcp::IfaceMgr.

diff --git a/src/lib/dhcp/std_option_defs.h b/src/lib/dhcp/std_option_defs.h
index b03326c03fbb23306f0fb0716bfea9eb9bf79440..c64528e7ee0185504c935cca00f37829da3d5fe5 100644 (file)
--- a/src/lib/dhcp/std_option_defs.h
+++ b/src/lib/dhcp/std_option_defs.h
@@ -28,7 +28,6 @@ namespace {
 /// of a definition for option comprising a record of data fields.
 ///
 /// @param name name of the array being declared.
-/// @param types data types of fields that belong to the record.
 #ifndef RECORD_DECL
 #define RECORD_DECL(name, ...) const OptionDataType name[] = { __VA_ARGS__ }
 #endif

diff --git a/src/lib/dhcpsrv/alloc_engine.h b/src/lib/dhcpsrv/alloc_engine.h
index 408e4dc91e00f39ee532e032c5ec844f9c5d68aa..d6f23ae53b2814233f0385e1252cb62febe132e4 100644 (file)
--- a/src/lib/dhcpsrv/alloc_engine.h
+++ b/src/lib/dhcpsrv/alloc_engine.h
@@ -408,9 +408,9 @@ public:
     /// response to SOLICIT).
     ///
     /// This method uses host reservation if ctx.host_ is set. The easy way to
-    /// set it is to call @ref AllocEngine::findReservation(ctx). The host reservation
-    /// is convenient, but incurs performance penalty, so it can be tweaked on
-    /// a per subnet basis. There are three possible modes:
+    /// set it is to call @ref isc::dhcp::AllocEngine::findReservation(ctx).
+    /// The host reservation is convenient, but incurs performance penalty,
+    /// so it can be tweaked on a per subnet basis. There are three possible modes:
     /// 1. disabled (no host reservation at all). This is the most performant one
     /// as the code can skip all checks;
     /// 2. out-of-pool (only reservations that are outside

diff --git a/src/lib/dhcpsrv/alloc_engine_log.h b/src/lib/dhcpsrv/alloc_engine_log.h
index c272255dd438ddea9bed07a8e2ab94cbcdc61422..39bf1a3ca727722eb3dbf6f2d6fa608137434f3a 100644 (file)
--- a/src/lib/dhcpsrv/alloc_engine_log.h
+++ b/src/lib/dhcpsrv/alloc_engine_log.h
@@ -21,7 +21,7 @@
 namespace isc {
 namespace dhcp {
 
-///@{
+//@{
 /// \brief Logging levels for the @c AllocEngine.
 ///
 /// Defines the levels used to output debug messages from the @c AllocEngine.
@@ -45,7 +45,7 @@ const int ALLOC_ENGINE_DBG_TRACE_DETAIL = DBGLVL_TRACE_DETAIL;
 /// Messages logged at this level will contain detailed results.
 const int ALLOC_ENGINE_DBG_TRACE_DETAIL_DATA = DBGLVL_TRACE_DETAIL_DATA;
 
-///@}
+//@}
 
 /// @brief Logger for the @c AllocEngine..
 ///

diff --git a/src/lib/dhcpsrv/parsers/dhcp_parsers.h b/src/lib/dhcpsrv/parsers/dhcp_parsers.h
index a5b2de757fe9b6bf0ee0795c103a58686fbc33d4..30d530aab32cf373a17ded445ed4c20f2d9e240f 100644 (file)
--- a/src/lib/dhcpsrv/parsers/dhcp_parsers.h
+++ b/src/lib/dhcpsrv/parsers/dhcp_parsers.h
@@ -958,7 +958,7 @@ protected:
     /// The elements currently supported are:
     /// -# ip-address
     ///
-    /// @param config_id is the "item_name" for a specific member element of
+    /// @param parser is the "item_name" for a specific member element of
     /// the "relay" specification.
     ///
     /// @return returns a pointer to newly created parser.
@@ -1058,6 +1058,8 @@ protected:
     /// Allowed values are "disabled", "off" (alias for disabled),
     /// "out-of-pool" and "all". See Subnet::HRMode for their exact meaning.
     ///
+    /// @param txt Host Reservation mode in the textual form.
+    ///
     /// @throw BadValue if the text cannot be converted.
     ///
     /// @param text representation for conversion

diff --git a/src/lib/log/logging.dox b/src/lib/log/logging.dox
index d53d8cccad7f26f9a812246c7eb2f6c4eb26a70f..fb2b52c567ecbe09b88b69188a7837fdb706db91 100644 (file)
--- a/src/lib/log/logging.dox
+++ b/src/lib/log/logging.dox
@@ -583,10 +583,8 @@ configuration. As soon as any specification is processed (even an
 empty one), the buffered log messages will be flushed according to
 the specification. Note that if this option is used, the program
 SHOULD call one of the @ref isc::log::LoggerManager::process() calls.
-(If you are using the built-in logging configuration handling in @ref
-isc::config::ModuleCCSession, this is automatically handled.) If the
-program exits before this is done, all log messages are dumped in a raw
-format to stdout (so that no messages get lost).</dd>
+If the program exits before this is done, all log messages are dumped
+in a raw format to stdout (so that no messages get lost).</dd>
 </dl>
 
 @subsubsection logInitializationCppVariant2 Variant #2, Used by Unit Tests

diff --git a/src/lib/util/optional_value.h b/src/lib/util/optional_value.h
index e8bf4d666f86e51cddc4edcbd742895165ac9c87..cf3c8f4f87bddbae6c9719c4c4b3a8ff7a8687de 100644 (file)
--- a/src/lib/util/optional_value.h
+++ b/src/lib/util/optional_value.h
@@ -107,7 +107,7 @@ public:
     ///
     /// It does not alter the actual value. It only marks it "specified" or
     /// "unspecified".
-    /// @param specified boolean that determined if a value is specified or not
+    /// @param state determines if a value is specified or not
     void specify(const OptionalValueState& state) {
         specified_ = state.specified_;
     }