Add class comments

Co-authored-by: Lukas Hagen <[email protected]>

packages/BaselineOfSVGMorph.package/BaselineOfSVGMorph.class/README.md

@@ -0,0 +1 @@
+A BaselineOfSVGMorph is the baseline of the SVGMorph Package.

packages/BaselineOfSVGMorph.package/BaselineOfSVGMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:09",
 	"instvars" : [
 		 ],
 	"name" : "BaselineOfSVGMorph",

packages/SVG-Editor.package/SVGEditor.class/README.md

@@ -0,0 +1,7 @@
+A SVGEditor is responsible for building the Editor window, including the editor panel.
+
+Instance Variables
+	model:		<SVGEditorModel>
+
+model:
+    - the editor model which will be inserted into the panel

packages/SVG-Editor.package/SVGEditor.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:08",
 	"instvars" : [
 		"model" ],
 	"name" : "SVGEditor",

packages/SVG-Editor.package/SVGEditorModel.class/README.md

@@ -0,0 +1,15 @@
+A SVGEditorModel is the model of the editor panel.
+
+Instance Variables
+	selectedElement:		<SVGComponentMorph>
+	selectedPath:		<OrderedCollection>
+	svg:		<SVGMorph>
+
+selectedElement:
+    - the element currently selected in the tree view
+
+selectedPath:
+    - the path of the element currently selected in the tree view
+
+svg:
+    - the svg object currently loaded

packages/SVG-Editor.package/SVGEditorModel.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:08",
 	"instvars" : [
 		"svg",
 		"selectedElement",

packages/SVG-Editor.package/SVGInfoPanelGenerator.class/README.md

@@ -0,0 +1,13 @@
+An SVGInfoPanelGenerator is a container object to be used with the multi-column info panel in the svg editor. Since a multi column list expects a collection for each column and not key value pairs, this container could be used to conviniently generate these collections.
+
+Instance Variables
+	keys:		<OrderedCollection>
+	values:		<OrderedCollection>
+
+keys
+	- The items to appear in the first column
+	- This should be the descriptions of the items in the second column
+
+values
+	- The items to appear in the first column
+	- This should the the respective values

packages/SVG-Editor.package/SVGInfoPanelGenerator.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:27",
 	"instvars" : [
 		"keys",
 		"values" ],

packages/SVG-Editor.package/SVGPanel.class/README.md

@@ -0,0 +1,15 @@
+A SVGPanel is a part of the editor window, on which the svg will be displayed.
+
+Instance Variables
+	model:		<SVGEditorModel>
+	svg:		<SVGMorph>
+	svgSelector:		<Symbol>
+
+model:
+    - the model component of this panel
+
+svg:
+    - the currently cached svg element
+
+svgSelector:
+    - the selector from which we can access the svg on the model.

packages/SVG-Editor.package/SVGPanel.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:09",
 	"instvars" : [
 		"svg",
 		"model",

packages/SVG-Editor.package/SVGPanelSpec.class/README.md

@@ -0,0 +1 @@
+A SVGPanelSpec is a pluggableComponentSpec designed to build SVGPanels.

packages/SVG-Editor.package/SVGPanelSpec.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:09",
 	"instvars" : [
 		 ],
 	"name" : "SVGPanelSpec",

packages/SVG-Morphic.package/SVGBalloonRenderer.class/README.md

@@ -0,0 +1 @@
+A SVGBalloonRenderer is a renderer for svgs, using the balloon engine.

packages/SVG-Morphic.package/SVGBalloonRenderer.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:14",
 	"instvars" : [
 		 ],
 	"name" : "SVGBalloonRenderer",

packages/SVG-Morphic.package/SVGBezierSegmentRun.class/README.md

@@ -0,0 +1 @@
+A SVGBezierSegmentRun is a segment run used for bezier curves.

packages/SVG-Morphic.package/SVGBezierSegmentRun.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:15",
 	"instvars" : [
 		 ],
 	"name" : "SVGBezierSegmentRun",

packages/SVG-Morphic.package/SVGCircleMorph.class/README.md

@@ -0,0 +1 @@
+A SVGCircleMorph is a morph representing the svg <circle> element.

packages/SVG-Morphic.package/SVGCircleMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:13",
 	"instvars" : [
 		 ],
 	"name" : "SVGCircleMorph",

packages/SVG-Morphic.package/SVGClosingLineSegment.class/README.md

@@ -0,0 +1 @@
+A SVGClosingLineSegment is a line segment that "closes" an SVG <path>. It is the last line segment of the path and leads back to the first point of the path.

packages/SVG-Morphic.package/SVGClosingLineSegment.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:18",
 	"instvars" : [
 		 ],
 	"name" : "SVGClosingLineSegment",

packages/SVG-Morphic.package/SVGComponentMorph.class/README.md

@@ -0,0 +1,24 @@
+A SVGComponentMorph is an abstract superclass for all svg elements.
+
+Instance Variables
+	cachedComposedStyle:		<Dictionary>
+	id:		<String>
+	renderer:		<SVGRenderer>
+	style:		<Dictionary>
+	transform:		<MatrixTransform2x3>
+
+cachedComposedStyle:
+    - the style of an element is the composition of its style and its parents styles
+    - this is a cache for this composed style
+
+id:
+    - the id of the element specified in the xml
+
+renderer:
+    - the renderer of this element
+
+style:
+    - the style specified for this element in the xml
+
+transform:
+    - the transformation matrix applied to this element

packages/SVG-Morphic.package/SVGComponentMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:09",
 	"instvars" : [
 		"id",
 		"style",

packages/SVG-Morphic.package/SVGCompositeMorph.class/README.md

@@ -0,0 +1,7 @@
+A SVGCompositeMorph is an abstract superclass for svg elements that can consist of child elements.
+
+Instance Variables
+	fills:		<Dictionary>
+
+fills
+	- the fill colors of this element

packages/SVG-Morphic.package/SVGCompositeMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:10",
 	"instvars" : [
 		"fills" ],
 	"name" : "SVGCompositeMorph",

packages/SVG-Morphic.package/SVGEllipseMorph.class/README.md

@@ -0,0 +1 @@
+A SVGEllipseMorph is a morph representing the svg <ellipse> element.

packages/SVG-Morphic.package/SVGEllipseMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:13",
 	"instvars" : [
 		 ],
 	"name" : "SVGEllipseMorph",

packages/SVG-Morphic.package/SVGFixupLineSegment.class/README.md

@@ -0,0 +1 @@
+A SVGFixupLineSegment is a line segment used as last segment for SVG <path> elements that should not appear as closed paths.

packages/SVG-Morphic.package/SVGFixupLineSegment.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:19",
 	"instvars" : [
 		 ],
 	"name" : "SVGFixupLineSegment",

packages/SVG-Morphic.package/SVGFixupLineSegmentRun.class/README.md

@@ -0,0 +1 @@
+A SVGLineSegmentRun is a segment run used for fixup lines.

packages/SVG-Morphic.package/SVGFixupLineSegmentRun.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:20",
 	"instvars" : [
 		 ],
 	"name" : "SVGFixupLineSegmentRun",

packages/SVG-Morphic.package/SVGGradientFillStyle.class/README.md

@@ -0,0 +1,11 @@
+A SVGGradientFillStyle is a fill style supporting svg gradients.
+
+Instance Variables
+	spread:		<Symbol>
+	units:		<Symbol>
+
+spread
+	- Defines how an element filled with this gradient will be filled beyond the area definied with this gradient
+
+units
+	- Defines the coordinate system used for the gradient

packages/SVG-Morphic.package/SVGGradientFillStyle.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:22",
 	"instvars" : [
 		"units",
 		"spread" ],

packages/SVG-Morphic.package/SVGGroupMorph.class/README.md

@@ -0,0 +1 @@
+A SVGGroupMorph is a morph representing the svg <g> element.

packages/SVG-Morphic.package/SVGGroupMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:10",
 	"instvars" : [
 		 ],
 	"name" : "SVGGroupMorph",

packages/SVG-Morphic.package/SVGLineMorph.class/README.md

@@ -0,0 +1 @@
+A SVGLineMorph is a morph representing the svg <line> element.

packages/SVG-Morphic.package/SVGLineMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:13",
 	"instvars" : [
 		 ],
 	"name" : "SVGLineMorph",

packages/SVG-Morphic.package/SVGLineSegmentRun.class/README.md

@@ -0,0 +1 @@
+A SVGLineSegmentRun is a segment run used for lines.

packages/SVG-Morphic.package/SVGLineSegmentRun.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:15",
 	"instvars" : [
 		 ],
 	"name" : "SVGLineSegmentRun",

packages/SVG-Morphic.package/SVGMorph.class/README.md

@@ -1,5 +1 @@
-Allows an SVGMorph to be opened in space
-
-A SVGMorph is xxxxxxxxx.
-
-Instance Variables
+A SVGMorph is a morph used to encapsule a whole svg structure. It allows an SVG to be opened in the world.

packages/SVG-Morphic.package/SVGMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "E.R 6/27/2020 11:19",
+	"commentStamp" : "lra 6/12/2022 20:10",
 	"instvars" : [
 		"viewBox",
 		"svgWidth",

packages/SVG-Morphic.package/SVGPathMorph.class/README.md

@@ -0,0 +1,17 @@
+A SVGPathMorph is a morph representing the svg <path> element.
+
+Instance Variables
+	originalD:		<String>
+	segments:		<SVGSegmentRun>
+
+originalD
+	- the original data from the xml, used for exporting it again.
+
+segments
+	- the segments of the path
+
+Instance Variables
+	points:		<OrderedCollection>
+
+points
+	- the points of polygon

packages/SVG-Morphic.package/SVGPathMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:11",
 	"instvars" : [
 		"segments",
 		"originalD" ],

packages/SVG-Morphic.package/SVGPolygonMorph.class/README.md

@@ -0,0 +1 @@
+A SVGPolygonMorph is a morph representing the svg <polygon> element.

packages/SVG-Morphic.package/SVGPolygonMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:11",
 	"instvars" : [
 		 ],
 	"name" : "SVGPolygonMorph",

packages/SVG-Morphic.package/SVGPolygonalMorph.class/README.md

@@ -0,0 +1,7 @@
+A SVGPolygonalMorph is an abstract superclass for svg <polygon> as well as <polyline> elements.
+
+Instance Variables
+	points:		<OrderedCollection>
+
+points
+	- A collection of the points if the polygonal element

packages/SVG-Morphic.package/SVGPolygonalMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:12",
 	"instvars" : [
 		"points" ],
 	"name" : "SVGPolygonalMorph",

packages/SVG-Morphic.package/SVGPolylineMorph.class/README.md

@@ -0,0 +1 @@
+A SVGPolylineMorph is a morph representing the svg <polyline> element.

packages/SVG-Morphic.package/SVGPolylineMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "lra 6/12/2022 20:13",
 	"instvars" : [
 		 ],
 	"name" : "SVGPolylineMorph",

packages/SVG-Morphic.package/SVGRectMorph.class/README.md

@@ -0,0 +1 @@
+A SVGRectMorph is a morph representing the svg <rect> element.