Merge pull request #86 from nilshah98/documentation

Documentation added and minor fixes

1 files changed, 31 insertions, 6 deletions

diff --git a/src/projManagement/Kicad.py b/src/projManagement/Kicad.py
index 2eaef643..9aaac46d 100644
--- a/src/projManagement/Kicad.py
+++ b/src/projManagement/Kicad.py
@@ -22,11 +22,22 @@ from configuration.Appconfig import Appconfig
 from . import Worker
 from PyQt4 import QtGui
 
+"""
+This class called the Kicad Schematic,KicadtoNgspice Converter,Layout
+editor and Footprint Editor
+"""
+
 
 class Kicad:
+
     """
-    This class called the Kicad Schematic,KicadtoNgspice Converter,Layout
-    editor and Footprint Editor
+        Initialise validation, appconfig and dockarea
+
+        @params
+            :dockarea   => passed from DockArea in frontEnd folder, consists
+                           of all functions for dockarea
+
+        @return
     """
 
     def __init__(self, dockarea):
@@ -34,10 +45,16 @@ class Kicad:
         self.obj_appconfig = Appconfig()
         self.obj_dockarea = dockarea
 
+    """
+    This function create command to open Kicad schematic after
+    appropriate validation checks
+
+    @params
+
+    @return
+    """
+
     def openSchematic(self):
-        """
-        This function create command to open Kicad schematic
-        """
         print("Function : Open Kicad Schematic")
         self.projDir = self.obj_appconfig.current_project["ProjectName"]
         try:
@@ -134,6 +151,14 @@ class Kicad:
             self.msg.setWindowTitle("Error Message")
 
     '''
+    """
+    This function create command to validate and then call
+    KicadToNgSPice converter from DockArea file
+
+    @params
+
+    @return
+    """
 
     def openKicadToNgspice(self):
         """
@@ -157,7 +182,7 @@ class Kicad:
 
                 # Creating a command to run
                 """
-                self.cmd = ("python  ../kicadtoNgspice/KicadtoNgspice.py "
+                self.cmd = ("python3  ../kicadtoNgspice/KicadtoNgspice.py "
                 + "self.project+".cir ")
                 self.obj_workThread = Worker.WorkerThread(self.cmd)
                 self.obj_workThread.start()