Browse Source

[2225_statistics] document about cases when a spec file is specified and omitted

Due to the review comment.
Naoki Kambe 12 years ago
parent
commit
c9e1f35632
1 changed files with 6 additions and 0 deletions
  1. 6 0
      src/lib/python/isc/statistics/counter.py

+ 6 - 0
src/lib/python/isc/statistics/counter.py

@@ -248,6 +248,12 @@ class Counters():
     _statistics = _Statistics()
 
     def __init__(self, spec_file_name=None):
+        """A constructor for the Counters class. A path of the spec
+        file can be specified in argument. Statistics data based on
+        statistics spec can be accumulated if specified. If omitted,
+        default statistics spec is used. Default statistics spec is
+        defined in other hidden class _Statistics().
+        """
         self._zones_item_list = []
         self._start_time = {}
         self._disabled = False