summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/subcircuit/Subcircuit.py4
-rw-r--r--src/subcircuit/convertSub.py5
-rw-r--r--src/subcircuit/newSub.py6
-rw-r--r--src/subcircuit/openSub.py4
4 files changed, 15 insertions, 4 deletions
diff --git a/src/subcircuit/Subcircuit.py b/src/subcircuit/Subcircuit.py
index 259ae40a..39c0fe77 100644
--- a/src/subcircuit/Subcircuit.py
+++ b/src/subcircuit/Subcircuit.py
@@ -6,9 +6,11 @@ from subcircuit.openSub import openSub
from subcircuit.convertSub import convertSub
+# This class creates Subcircuit GUI.
class Subcircuit(QtGui.QWidget):
"""
- This class creates Subcircuit GUI.
+ Creates buttons for New project, Edit existing project and
+ Kicad Netlist to Ngspice Netlist converter.
"""
def __init__(self, parent=None):
diff --git a/src/subcircuit/convertSub.py b/src/subcircuit/convertSub.py
index 31ae3022..cce27476 100644
--- a/src/subcircuit/convertSub.py
+++ b/src/subcircuit/convertSub.py
@@ -4,9 +4,12 @@ from configuration.Appconfig import Appconfig
import os
+# This class is called when User create new Project and contains \
+# functions to convert kicad to Ngspice.
class convertSub(QtGui.QWidget):
"""
- This class is called when User create new Project.
+ Contains functions that checks project present for conversion and
+ also function to convert Kicad to Ngspice.
"""
def __init__(self, dockarea):
diff --git a/src/subcircuit/newSub.py b/src/subcircuit/newSub.py
index c39f7c7a..d94f4395 100644
--- a/src/subcircuit/newSub.py
+++ b/src/subcircuit/newSub.py
@@ -5,9 +5,13 @@ from projManagement import Worker
import os
+# This class is called when User create new Project.
class NewSub(QtGui.QWidget):
"""
- This class is called when User create new Project.
+ Contains funstions to check :
+ - Name of project should not be blank.
+ - Name should not contain space between them.
+ - Name does not match with existing project.
"""
def __init__(self):
diff --git a/src/subcircuit/openSub.py b/src/subcircuit/openSub.py
index ba6d0617..4c1394eb 100644
--- a/src/subcircuit/openSub.py
+++ b/src/subcircuit/openSub.py
@@ -4,9 +4,11 @@ from projManagement.Worker import WorkerThread
import os
+# This class is called when User clicks on Edit Subcircuit Button.
class openSub(QtGui.QWidget):
"""
- This class is called when User click on Open Project Button
+ It opens the existing subcircuit projects that are present in
+ Subcircuit Library.
"""
def __init__(self):