Parcourir la source

[2157] update doxygen, remove extra header includes

Yoshitaka Aharen il y a 12 ans
Parent
commit
bb6e5acc09

+ 1 - 1
src/bin/auth/auth_srv.h

@@ -204,7 +204,7 @@ public:
     /// \brief Returns statistics data
     ///
     /// This function can throw an exception from
-    /// Counters::getStatistics().
+    /// Counters::get().
     ///
     /// \return JSON format statistics data.
     isc::data::ConstElementPtr getStatistics() const;

+ 0 - 1
src/bin/auth/statistics.cc.pre

@@ -20,7 +20,6 @@
 #include <dns/rcode.h>
 
 #include <cc/data.h>
-#include <cc/session.h>
 
 #include <algorithm>
 #include <cctype>

+ 6 - 13
src/bin/auth/statistics.h

@@ -15,7 +15,6 @@
 #ifndef __STATISTICS_H
 #define __STATISTICS_H 1
 
-#include <cc/session.h>
 #include <cc/data.h>
 
 #include <dns/message.h>
@@ -194,27 +193,21 @@ public:
 
 /// \brief Set of DNS message counters.
 ///
-/// \c Counters is set of DNS message counters class. It holds DNS message
+/// \c Counters is a set of DNS message counters class. It holds DNS message
 /// counters and provides an interface to increment the counter of specified
 /// type (e.g. UDP message, TCP message).
 ///
-/// This class also provides a function to send statistics information to
-/// statistics module.
-///
 /// This class is designed to be a part of \c AuthSrv.
 /// Call \c inc() to increment a counter for the message.
-/// Call \c getStatistics() to answer statistics information to statistics
-/// module with statistics_session, when the command \c getstats is received.
+/// Call \c get() to get a set of DNS message counters.
 ///
 /// We may eventually want to change the structure to hold values that are
 /// not counters (such as concurrent TCP connections), or seperate generic
 /// part to src/lib to share with the other modules.
 ///
-/// This class uses pimpl idiom and hides detailed implementation.
 /// This class is constructed on startup of the server, so
 /// construction overhead of this approach should be acceptable.
 ///
-/// \todo Hold counters for each message types (Notify, Axfr, Ixfr, Normal)
 /// \todo Consider overhead of \c Counters::inc()
 class Counters : boost::noncopyable {
 private:
@@ -248,8 +241,8 @@ public:
 
     /// \brief Increment counters according to the parameters.
     ///
-    /// This constructor is mostly exception free. But it may still throw
-    /// a standard exception if memory allocation fails inside the method.
+    /// This method is mostly exception free. But it may still throw a
+    /// standard exception if memory allocation fails inside the method.
     ///
     /// \param msgattrs DNS message attributes.
     /// \param response DNS response message.
@@ -262,8 +255,8 @@ public:
 
     /// \brief Get statistics counters.
     ///
-    /// This method is mostly exception free. But it may still throw
-    /// a standard exception if memory allocation fails inside the method.
+    /// This method is mostly exception free. But it may still throw a
+    /// standard exception if memory allocation fails inside the method.
     ///
     /// \return statistics data
     ///

+ 0 - 2
src/bin/auth/tests/statistics_unittest.cc.pre

@@ -23,7 +23,6 @@
 #include <dns/rrttl.h>
 
 #include <cc/data.h>
-#include <cc/session.h>
 
 #include <auth/statistics.h>
 #include <auth/statistics_items.h>
@@ -40,7 +39,6 @@
 #include <netdb.h>
 
 using namespace std;
-using namespace isc::cc;
 using namespace isc::dns;
 using namespace isc::data;
 using namespace isc::auth::statistics;