Cfg: documented all Cfg modules, added development docs

1 files changed, 12 insertions, 0 deletions

diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgLegacyInfo.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgLegacyInfo.py
index 3673cfcb2..a47663904 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgLegacyInfo.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgLegacyInfo.py
@@ -1,3 +1,5 @@
+""" Handle info and :info files """
+
 import logging
 import Bcfg2.Server.Plugin
 from Bcfg2.Server.Plugins.Cfg import CfgInfo
@@ -5,15 +7,24 @@ from Bcfg2.Server.Plugins.Cfg import CfgInfo
 logger = logging.getLogger(__name__)
 
 class CfgLegacyInfo(CfgInfo):
+    """ CfgLegacyInfo handles :file:`info` and :file:`:info` files for
+    :ref:`server-plugins-generators-cfg` """
+
+    #: Handle :file:`info` and :file:`:info`
     __basenames__ = ['info', ':info']
+
+    #: CfgLegacyInfo is deprecated.  Use
+    #: :class:`Bcfg2.Server.Plugins.Cfg.CfgInfoXML.CfgInfoXML` instead.
     deprecated = True
 
     def __init__(self, path):
         CfgInfo.__init__(self, path)
         self.path = path
+    __init__.__doc__ = CfgInfo.__init__.__doc__
 
     def bind_info_to_entry(self, entry, metadata):
         self._set_info(entry, self.metadata)
+    bind_info_to_entry.__doc__ = CfgInfo.bind_info_to_entry.__doc__
 
     def handle_event(self, event):
         if event.code2str() == 'deleted':
@@ -31,3 +42,4 @@ class CfgLegacyInfo(CfgInfo):
                 if ('perms' in self.metadata and
                     len(self.metadata['perms']) == 3):
                     self.metadata['perms'] = "0%s" % self.metadata['perms']
+    handle_event.__doc__ = CfgInfo.handle_event.__doc__