added some module-level docstrings

git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@1443 e5f2f494-b856-4b98-b285-d166d9295462

src/bin/bindctl/bindcmd.py

@@ -13,6 +13,11 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+"""This module holds the BindCmdInterpreter class. This provides the
+   core functionality for bindctl. It maintains a session with
+   b10-cmdctl, holds local configuration and module information, and
+   handles command line interface commands"""
+
 import sys
 from cmd import Cmd
 from bindctl.exception import *

src/bin/bindctl/bindctl-source.py.in

@@ -15,6 +15,8 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+"""This is the main calling class for the bindctl configuration and
+   command tool. It sets up a command interpreter and runs that."""
 
 import sys; sys.path.append ('@@PYTHONPATH@@')
 
@@ -26,6 +28,7 @@ from optparse import OptionParser, OptionValueError
 __version__ = 'Bindctl'
 
 def prepare_config_commands(tool):
+    '''Prepare fixed commands for local configuration editing'''
     module = ModuleInfo(name = "config", desc = "Configuration commands")
     cmd = CommandInfo(name = "show", desc = "Show configuration")
     param = ParamInfo(name = "identifier", type = "string", optional=True)

src/bin/bindctl/cmdparse.py

@@ -13,6 +13,9 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+
+"""This module holds the command parser class for bindctl"""
+
 import re
 from bindctl.exception import *
 try:

src/bin/bindctl/exception.py

@@ -13,7 +13,7 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
-
+"""This module holds exception classes specific for bindctl"""
 class BindCtlException(Exception):
     """Abstract base class shared by all bindctl exceptions"""
     def __str__(self):

src/bin/bindctl/moduleinfo.py

@@ -13,6 +13,8 @@
 # NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 # WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+"""This module holds classes representing modules, commands and
+   parameters for use in bindctl"""
 
 try:
     from collections import OrderedDict