Browse Source

[2157] minor comment fix

Yoshitaka Aharen 12 years ago
parent
commit
2ac23d0d57
3 changed files with 15 additions and 13 deletions
  1. 4 2
      src/bin/auth/statistics.cc.pre
  2. 4 5
      src/bin/auth/statistics.h
  3. 7 6
      src/bin/auth/statistics_items.h.pre

+ 4 - 2
src/bin/auth/statistics.cc.pre

@@ -44,8 +44,10 @@ namespace {
 
 /// \brief Fill ItemTreePtr with given counter.
 /// \param counter Counter which stores values to fill
-/// \param type_tree CounterSpec corresponding to counter for building item name
-/// \param trees ItemTreePtr to be filled in; caller has ownership of ItemTreePtr
+/// \param type_tree CounterSpec corresponding to counter for building item
+///                  name
+/// \param trees ItemTreePtr to be filled in; caller has ownership of
+///              ItemTreePtr
 void
 fillNodes(const Counter& counter,
           const struct isc::auth::statistics::CounterSpec type_tree[],

+ 4 - 5
src/bin/auth/statistics.h

@@ -114,7 +114,6 @@ public:
 
     /// \brief Set request EDNS attributes.
     /// \param is_edns_0 true if request is EDNS version 0
-    /// \param is_edns_badver true if request is EDNS version other than 0
     /// \throw None
     void setRequestEDNS0(const bool is_edns_0) {
         bit_attributes_[REQ_IS_EDNS_0] = is_edns_0;
@@ -134,15 +133,15 @@ public:
         bit_attributes_[REQ_IS_DNSSEC_OK] = is_dnssec_ok;
     };
 
-    /// \brief Get request TSIG signed and verified.
-    /// \return true if request is TSIG signed and verified
+    /// \brief Get request TSIG signed.
+    /// \return true if request is TSIG signed
     /// \throw None
     bool getRequestSigTSIG() const {
         return (bit_attributes_[REQ_IS_TSIG]);
     };
 
-    /// \brief Get request SIG(0) signed and verified.
-    /// \return true if request is SIG(0) signed and verified
+    /// \brief Get request SIG(0) signed.
+    /// \return true if request is SIG(0) signed
     /// \throw None
     bool getRequestSigSIG0() const {
         return (bit_attributes_[REQ_IS_SIG0]);

+ 7 - 6
src/bin/auth/statistics_items.h.pre

@@ -23,14 +23,15 @@ namespace auth {
 namespace statistics {
 
 struct CounterSpec {
-    // item name: Name of this node. This appears in the spec file.
+    /// \brief name Name of this node. This appears in the spec file.
     const char* const name;
-    // sub counters: If this is a branch node, sub_counters points to
-    //               CounterSpec which contains child nodes. Otherwise, for
-    //               leaf nodes, sub_counters is NULL.
+    /// \brief sub_counters If this is a branch node, sub_counters points to
+    ///                     CounterSpec which contains child nodes. Otherwise,
+    ///                     for leaf nodes, sub_counters is NULL.
     const struct CounterSpec* const sub_counters;
-    // counter id: If this is a leaf node, counter_id is an enumerator of this
-    //             item. Otherwise, for branch nodes, counter_id is NOT_ITEM.
+    /// \brief counter_id If this is a leaf node, counter_id is an enumerator
+    ///                   of this item. Otherwise, for branch nodes, counter_id
+    ///                   is NOT_ITEM.
     const int counter_id;
 };