Add comment for each method and class

[bertos.git] / wizard / BWizardPage.py

diff --git a/wizard/BWizardPage.py b/wizard/BWizardPage.py
index 81737e34249b34652f9810d2dc21e89486fcae27..e1a815d1ccbbc360e61e9121cef98234b29532f3 100644 (file)
--- a/wizard/BWizardPage.py
+++ b/wizard/BWizardPage.py
@@ -16,6 +16,10 @@ from PyQt4 import uic
 import qvariant_converter
 
 class BWizardPage(QWizardPage):
+    """
+    Base class for all the wizard pages. It has the utility method used in all
+    the pages. A wizard page class need to extend this class.
+    """
     
     def __init__(self, wizardGui, parent = None):
         QWizardPage.__init__(self, parent)
@@ -25,49 +29,94 @@ class BWizardPage(QWizardPage):
         self.setLayout(layout)
     
     def _exceptionOccurred(self, message):
+        """
+        Simple message box showing method.
+        """
         QMessageBox.critical(self, self.tr("Error occurred"), message, QMessageBox.Ok, QMessageBox.NoButton)
     
     def _settingsStore(self, key, value):
+        """
+        Stores the given value in the QSettings associated with the given key.
+        """
         QApplication.instance().settings.setValue(QString(key), value)
     
     def _settingsRetrieve(self, key):
+        """
+        Retrieves the value associated to key in the QSettings. Note that this
+        Value is a QVariant and neet to be converted in a standard type.
+        """
         return QApplication.instance().settings.value(QString(key), QVariant())
     
     def _projectInfoStore(self, key, value):
+        """
+        Stores the given value in the BProject class associating it with the given
+        key.
+        """
         QApplication.instance().project.setInfo(key, value)
     
     def _projectInfoRetrieve(self, key):
+        """
+        Retrieves the information associated with the given key.
+        """
         return QApplication.instance().project.info(key)
     
     def _project(self):
+        """
+        Returns the BProject instance.
+        """
         return QApplication.instance().project
 
     def versions(self):
+        """
+        Returns the version list from the QSettings.
+        """
         return qvariant_converter.getStringList(self._settingsRetrieve("versions"))
     
     def setVersions(self, versions):
+        """
+        Stores the given versions in the QSettings.
+        """
         self._settingsStore("versions", qvariant_converter.convertStringList(versions))
         
     def searchDirList(self):
+        """
+        Returns the search dir list from the QSettings.
+        """
         return qvariant_converter.getStringList(self._settingsRetrieve("search_dir_list"))
     
     def setSearchDirList(self, search_dir_list):
+        """
+        Stores the search dir list in the QSettings.
+        """
         self._settingsStore("search_dir_list", qvariant_converter.convertStringList(search_dir_list))
     
     def pathSearch(self):
+        """
+        Returns the value of path search from the QSettings.
+        """
         return qvariant_converter.getBool(self._settingsRetrieve("path_search"))
     
     def setPathSearch(self, path_search):
+        """
+        Stores the path search value in the QSettings.
+        """
         self._settingsStore("path_search", qvariant_converter.convertBool(path_search))
     
     def toolchains(self):
+        """
+        Returns the toolchains stored in the QSettings.
+        """
         return qvariant_converter.getBoolDict(self._settingsRetrieve("toolchains"))
 
     def setToolchains(self, toolchains):
+        """
+        Stores the toolchains in the QSettings.
+        """
         self._settingsStore("toolchains", qvariant_converter.convertBoolDict(toolchains))
     
     def reloadData(self):
+        """
+        Method called before the page is loaded. The pages that need to use this
+        method have to implement it.
+        """
         pass
-    
-    def saveData(self):
-        pass
\ No newline at end of file