summaryrefslogtreecommitdiff
path: root/gerber/gerber_statements.py
diff options
context:
space:
mode:
Diffstat (limited to 'gerber/gerber_statements.py')
-rw-r--r--gerber/gerber_statements.py28
1 files changed, 28 insertions, 0 deletions
diff --git a/gerber/gerber_statements.py b/gerber/gerber_statements.py
index 76a6f0c..4c5133a 100644
--- a/gerber/gerber_statements.py
+++ b/gerber/gerber_statements.py
@@ -16,6 +16,20 @@ __all__ = ['FSParamStmt', 'MOParamStmt', 'IPParamStmt', 'OFParamStmt',
class Statement(object):
+ """ Gerber statement Base class
+
+ The statement class provides a type attribute.
+
+ Parameters
+ ----------
+ type : string
+ String identifying the statement type.
+
+ Attributes
+ ----------
+ type : string
+ String identifying the statement type.
+ """
def __init__(self, stype):
self.type = stype
@@ -30,6 +44,20 @@ class Statement(object):
class ParamStmt(Statement):
+ """ Gerber parameter statement Base class
+
+ The parameter statement class provides a parameter type attribute.
+
+ Parameters
+ ----------
+ param : string
+ two-character code identifying the parameter statement type.
+
+ Attributes
+ ----------
+ param : string
+ Parameter type code
+ """
def __init__(self, param):
Statement.__init__(self, "PARAM")
self.param = param