Add comment for each method and class

[bertos.git] / wizard / BWizard.py

diff --git a/wizard/BWizard.py b/wizard/BWizard.py
index 7c2b0f4bc6c73c0302c3db77d8b74f61307a6aaa..004fdf3e534c450796719f663670e522d8c7da1a 100644 (file)
--- a/wizard/BWizard.py
+++ b/wizard/BWizard.py
@@ -24,17 +24,21 @@ import BCreationPage
 import BFinalPage
 
 class BWizard(QWizard):
+    """
+    Main class of the wizard. It adds the pages automatically.
+    """
     
     def __init__(self):
         QWizard.__init__(self)
-        # TODO: choose the right minimum size
-        self.setMinimumSize(1000, 500)
         self.setWindowTitle(self.tr("Create a BeRTOS project"))
         self.setOption(QWizard.DisabledBackButtonOnLastPage, True)
         self._addPages()
         self._connectSignals()
     
     def _addPages(self):
+        """
+        Method used by the constructor in order to add the pages in the wizard.
+        """
         self.addPage(BFolderPage.BFolderPage())
         self.addPage(BVersionPage.BVersionPage())
         self.addPage(BCpuPage.BCpuPage())
@@ -45,15 +49,22 @@ class BWizard(QWizard):
         self.addPage(BFinalPage.BFinalPage())
     
     def _connectSignals(self):
+        """
+        Connects the signals with the related slots.
+        """
         self.connect(self, SIGNAL("currentIdChanged(int)"), self._pageChanged)
     
     def _pageChanged(self, pageId):
-        prev_page = self.page(pageId - 1)
-        if prev_page is not None:
-            prev_page.saveData()
+        """
+        Slot called when the user change the current page. It calls the reloadData
+        method of the next page.
+        """
         page = self.page(pageId)
         if page is not None:
             page.reloadData()
     
     def project(self):
+        """
+        Returns the BProject associated with the wizard.
+        """
         return copy.deepcopy(QApplication.instance().project)