sphinx documentation init

1 files changed, 21 insertions, 26 deletions

diff --git a/src/projManagement/Kicad.py b/src/projManagement/Kicad.py
index 9aaac46d..b75c0cf6 100644
--- a/src/projManagement/Kicad.py
+++ b/src/projManagement/Kicad.py
@@ -22,22 +22,19 @@ 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:
 
     """
-        Initialise validation, appconfig and dockarea
+    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
+    @params
+        :dockarea   => passed from DockArea in frontEnd folder, consists
+                        of all functions for dockarea
 
-        @return
+    @return
     """
 
     def __init__(self, dockarea):
@@ -45,16 +42,17 @@ 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 after
+        appropriate validation checks
+
+        @params
+
+        @return
+        """
         print("Function : Open Kicad Schematic")
         self.projDir = self.obj_appconfig.current_project["ProjectName"]
         try:
@@ -151,18 +149,15 @@ 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):
         """
-        This function create command to call kicad to Ngspice converter.
+        This function create command to validate and then call
+        KicadToNgSPice converter from DockArea file
+
+        @params
+
+        @return
         """
         print("Function: Open Kicad to Ngspice Converter")