linted class comments

packages/MarkdownEditor-Core.package/MarkdownBlockStylerMorph.class/README.md

@@ -2,10 +2,10 @@ A MarkdownBlockStylerMorph offers an UI to change a block's font size and font c
 
 Instance Variables
 	classCategory:		<String>
-	classLabel:		<TextMorph>
+	classLabel:			<TextMorph>
 	fontColorPicker:		<MarkdownColorChooser>
 	fontSizeSlider:		<MarkdownSlider>
-	sliderLabel:		<TextMorph>
+	sliderLabel:			<TextMorph>
 	styleSettings:		<MarkdownStyleSettings>
 
 classCategory
@@ -15,7 +15,7 @@ classLabel
 	- is the name of the block
 
 fontColorPicker
-	- is used to select the colour of the block and consists of a standard color selector and a color selector
+	- is used to select the color of the block
 
 fontSizeSlider
 	- is used to select the font size

packages/MarkdownEditor-Core.package/MarkdownBlockStylerMorph.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 15:58",
+	"commentStamp" : "jh 8/5/2021 08:57",
 	"instvars" : [
 		"classLabel",
 		"classCategory",

packages/MarkdownEditor-Core.package/MarkdownEditor.class/README.md

@@ -3,15 +3,16 @@ A MarkdownEditor provides a simple text area for writing Markdown documents, for
 Instance Variables
 	currentFilePath:		<ByteString>
 	markdownMenu:		<MarkdownEditorMenu>
-	markdownText:		<Text>
-	pluggableTextMorph:		<PluggableTextMorphPlus>
-	window:		<PluggableSystemWindow>
+	markdownText:			<Text>
+	pluggableTextMorph:	<PluggableTextMorphPlus>
+	window:				<PluggableSystemWindow>
 
 currentFilePath
 	- is the current file path used to open and save files
 
 markdownMenu
-	- is the menu with which a user can interact with the editor, e.g. open the settings menu and display the parsing tree
+	- is the yellowbutton menu with which a user can interact with the editor, 
+	e.g. open the settings menu and display the parsing tree
 
 markdownText
 	- is the text that a user writes in the editor

packages/MarkdownEditor-Core.package/MarkdownEditor.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 16:11",
+	"commentStamp" : "jh 8/5/2021 08:58",
 	"instvars" : [
 		"markdownText",
 		"pluggableTextMorph",

packages/MarkdownEditor-Core.package/MarkdownHtmlConverter.class/README.md

@@ -1,3 +1 @@
-A MarkdownHtmlConverter converts Markdown text into HTML. It is implemented as a double dispatch. This is why the converter has so much knowledge about the different blocks, but it also causes the linter to complain about a violation of the Law of Demeter. This construction is intentional.
-
-Instance Variables
+A MarkdownHtmlConverter converts Markdown text into HTML. It is implemented as a double dispatch. This is why the converter has so much knowledge about the different blocks, but it also causes the linter to complain about a violation of the Law of Demeter. This construction is intentional.

packages/MarkdownEditor-Core.package/MarkdownHtmlConverter.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 15:31",
+	"commentStamp" : "jh 8/5/2021 08:58",
 	"instvars" : [
 		 ],
 	"name" : "MarkdownHtmlConverter",

packages/MarkdownEditor-Core.package/MarkdownHtmlExportView.class/README.md

@@ -1,3 +1 @@
-A MarkdownHtmlExportView displays the converted HTML lines.
-
-Instance Variables
+A MarkdownHtmlExportView displays the converted HTML lines.

packages/MarkdownEditor-Core.package/MarkdownHtmlExportView.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 15:31",
+	"commentStamp" : "jh 8/5/2021 08:58",
 	"instvars" : [
 		 ],
 	"name" : "MarkdownHtmlExportView",

packages/MarkdownEditor-Core.package/MarkdownSettings.class/README.md

@@ -1,13 +1,13 @@
-A MarkdownSettings is a singleton that allows the user to change the appearances for each block.
+A MarkdownSettings is a singleton that allows the user to change the appearances for each block. When you are having troubles with it, consider to reset the singleton by calling MarkdownSettings deleteInstance, this will reset your style settings to the default style settings dependent on the theme you are using.
 
 Instance Variables
 	blockStylerMorphs:		<OrderedCollection>
-	contentMorph:		<PluggableScrollPane>
-	currentStyleSettings:		<MarkdownStyleSettings>
-	editors:		<MarkdownEditor>
+	contentMorph:			<PluggableScrollPane>
+	currentStyleSettings:	<MarkdownStyleSettings>
+	editors:					<MarkdownEditor>
 	newStyleSettings:		<MarkdownStyleSettings>
 	settingsVersion:		<SmallInteger>
-	window:		<PluggableSystemWindow>
+	window:				<PluggableSystemWindow>
 
 blockStylerMorphs
 	- is a collection of BlockStylerMorphs that include the styling for each block
@@ -16,13 +16,14 @@ contentMorph
 	- is the area in which the BlockStylerMorphs are displayed in the window
 
 currentStyleSettings
-	- are the style settings that a user is using at the moment
+	- current settings for all font sizes and colors of all styling elements.
 
 editors
-	- is a collection of editors that use these style settings
+	- a collection of dependent editors to be able to give a preview of current settings.
 
 newStyleSettings
-	- are the style settings that a user will use when confirming changed style settings
+	- new selected settings for all font sizes and colors for all styling elements, 
+	becomes currentStyleSettings when hitting apply.
 
 settingsVersion
 	- is a version number of the settings

packages/MarkdownEditor-Core.package/MarkdownSettings.class/properties.json

@@ -4,7 +4,7 @@
 		"UniqueInstance" ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/5/2021 00:47",
+	"commentStamp" : "jh 8/5/2021 09:01",
 	"instvars" : [
 		"blockStylerMorphs",
 		"contentMorph",

packages/MarkdownEditor-Core.package/MarkdownTextStyler.class/README.md

@@ -2,7 +2,7 @@ A MarkdownTextStyler styles all blocks of parsed Markdown text.
 
 Instance Variables
 	document:		<MarkdownDocument>
-	text:		<Text>
+	text:			<Text>
 
 document
 	- is the parsed Markdown text in tree structure

packages/MarkdownEditor-Core.package/MarkdownTextStyler.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 16:05",
+	"commentStamp" : "jh 8/5/2021 09:02",
 	"instvars" : [
 		"document",
 		"text" ],

packages/MarkdownEditor-Core.package/MarkdownUrlContentDisplay.class/README.md

@@ -2,7 +2,7 @@ A MarkdownUrlContentDisplay displays the content of the accessed websites, image
 
 Instance Variables
 	contentText:		<TextMorph>
-	mime:		<MIMEDocument>
+	mime:				<MIMEDocument>
 
 contentText
 	- is the area in which the content of e.g. a website is displayed

packages/MarkdownEditor-Core.package/MarkdownUrlContentDisplay.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 16:12",
+	"commentStamp" : "jh 8/5/2021 09:02",
 	"instvars" : [
 		"mime",
 		"contentText" ],

packages/MarkdownEditor-Parsing.package/MarkdownBlock.class/README.md

@@ -1,11 +1,11 @@
 A MarkdownBlock represents a block in the document tree after parsing.
 
 Instance Variables
-	container:		<MarkdownContainerBlock>
+	container:			<MarkdownContainerBlock>
 	endPosition:		<SmallInteger>
-	innerLine:		<ByteString>
-	innerStartPosition:		<SmallInteger>
-	open:		<Boolean>
+	innerLine:			<ByteString>
+	innerStartPosition:	<SmallInteger>
+	open:				<Boolean>
 	startPosition:		<SmallInteger>
 
 container

packages/MarkdownEditor-Parsing.package/MarkdownBlock.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 23:09",
+	"commentStamp" : "jh 8/5/2021 08:43",
 	"instvars" : [
 		"container",
 		"endPosition",

packages/MarkdownEditor-Parsing.package/MarkdownBlockquote.class/README.md

@@ -1,3 +1 @@
-A MarkdownBlockquote represents a blockquote in the document tree after parsing.
-
-Instance Variables
+A MarkdownBlockquote represents a blockquote in the document tree after parsing.

packages/MarkdownEditor-Parsing.package/MarkdownBlockquote.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 23:09",
+	"commentStamp" : "jh 8/5/2021 08:43",
 	"instvars" : [
 		 ],
 	"name" : "MarkdownBlockquote",

packages/MarkdownEditor-Parsing.package/MarkdownBold.class/README.md

@@ -1,3 +1 @@
-A MarkdownBold contains bold text after parsing.
-
-Instance Variables
+A MarkdownBold contains bold text after parsing.

packages/MarkdownEditor-Parsing.package/MarkdownBold.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 16:51",
+	"commentStamp" : "jh 8/5/2021 08:52",
 	"instvars" : [
 		 ],
 	"name" : "MarkdownBold",

packages/MarkdownEditor-Parsing.package/MarkdownCodeSpan.class/README.md

@@ -6,10 +6,10 @@ Instance Variables
 	rawContent:		<ByteString>
 
 code
-	- is the parsed text with stripped white spaces
+	- is the parsed text with stripped white spaces according to spec
 
 fenceLength
 	- is the length of the fence
 
 rawContent
-	- is the text between the fences before parsing
+	- is the text between the fences without stripping

packages/MarkdownEditor-Parsing.package/MarkdownCodeSpan.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 23:11",
+	"commentStamp" : "jh 8/5/2021 08:50",
 	"instvars" : [
 		"fenceLength",
 		"rawContent",

packages/MarkdownEditor-Parsing.package/MarkdownContainerBlock.class/README.md

@@ -4,4 +4,4 @@ Instance Variables
 	children:		<OrderedCollection>
 
 children
-	- is a collection of leaf blocks
+	- is a collection of blocks

packages/MarkdownEditor-Parsing.package/MarkdownContainerBlock.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 23:13",
+	"commentStamp" : "jh 8/5/2021 08:44",
 	"instvars" : [
 		"children" ],
 	"name" : "MarkdownContainerBlock",

packages/MarkdownEditor-Parsing.package/MarkdownDelimiter.class/README.md

@@ -1,35 +1,37 @@
 A MarkdownDelimiter represents a delimiter during the inline parsing phases.
 
 Instance Variables
-	count:		<SmallInteger>
-	inlineIndex:		<SmallInteger>
+	count:							<SmallInteger>
+	inlineIndex:						<SmallInteger>
 	originalOpenerAndCloser:		<Boolean>
-	potentialCloser:		<Boolean>
-	potentialOpener:		<Boolean>
-	startPosition:		<SmallInteger>
-	type:		<Character>
-	valid:		<Boolean>
+	potentialCloser:					<Boolean>
+	potentialOpener:				<Boolean>
+	startPosition:					<SmallInteger>
+	type:							<Character>
+	valid:							<Boolean>
 
 count
-	- indicates the number of delimiters, e.g. one * for italic or two * for bold
+	- number of delimiter symbols
 
 inlineIndex
-	- xxxxx
+	- temporarily valid index of delimiter in list of all inline elements
 
 originalOpenerAndCloser
-	- is a boolean indicating whether a delimiter is an original opening delimiter and an original closing delimiter
+	- expresses if a delimiter is originally designed to be open and close an emphasis. 
+	It is determined by the delimiter itself and should not be set from outside.
 
 potentialCloser
-	- is a boolean indicating whether a delimiter is an potential closing delimiter
+	- expresses if a delimiter is able to close an emphasis span.
 
 potentialOpener
-	- is a boolean indicating whether a delimiter is an potential opening delimiter
+	- expresses if a delimiter is able to open an emphasis span.
 
 startPosition
-	- is the start position in the Markdown text
+	- absolute start position within the text.
 
 type
-	- is the type of the delimiter like *, _ or ~
+	- determines what emphasis it belongs to, current types are: $~, $*, $_
 
 valid
-	- is a boolean value that indicates whether a delimiter is valid or invalid, e.g. the delimiter is invalid if the devisible by three rule applies
+	- creating a delimiter with new will generate an invalid delimiter, 
+	if you want a valid delimiter you should use newFrom:.

packages/MarkdownEditor-Parsing.package/MarkdownDelimiter.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 23:24",
+	"commentStamp" : "jh 8/5/2021 08:49",
 	"instvars" : [
 		"count",
 		"inlineIndex",

packages/MarkdownEditor-Parsing.package/MarkdownDocument.class/README.md

@@ -1,3 +1 @@
-A MarkdownDocument represents a document in the document tree after parsing.
-
-Instance Variables
+A MarkdownDocument represents a document in the document tree after parsing.

packages/MarkdownEditor-Parsing.package/MarkdownDocument.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 23:09",
+	"commentStamp" : "jh 8/5/2021 08:44",
 	"instvars" : [
 		 ],
 	"name" : "MarkdownDocument",

packages/MarkdownEditor-Parsing.package/MarkdownEmphasis.class/README.md

@@ -1,3 +1 @@
-A MarkdownEmphasis represent a MarkdownEmphasis over a range of characters after parsing. The applied styling is expressed through my textAttribute and colorAttribute.
-
-Instance Variables
+A MarkdownInlineContainerBlock is an inline element and super class for all inline elements defining an emphasis, such as italic, bold ore struck out. It is defined over a reange of characters in a text.

packages/MarkdownEditor-Parsing.package/MarkdownEmphasis.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 16:51",
+	"commentStamp" : "jh 8/5/2021 08:52",
 	"instvars" : [
 		 ],
 	"name" : "MarkdownEmphasis",

packages/MarkdownEditor-Parsing.package/MarkdownFencedCodeBlock.class/README.md

@@ -2,7 +2,7 @@ A MarkdownFencedCodeBlock represents a fenced code block in the document tree af
 
 Instance Variables
 	indentation:		<SmallInteger>
-	info:		<ByteString>
+	info:				<ByteString>
 	openingFence:		<ByteString>
 
 indentation
@@ -12,4 +12,5 @@ info
 	- is a string indicating the programming language used in the fenced code block
 
 openingFence
-	- is the opening fence of the fenced code block and consists of a sequence of at least three consecutive backtick characters or tildes
+	- is the opening fence of the fenced code block and 
+	consists of a sequence of at least three consecutive backtick characters or tildes

packages/MarkdownEditor-Parsing.package/MarkdownFencedCodeBlock.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 23:10",
+	"commentStamp" : "jh 8/5/2021 08:47",
 	"instvars" : [
 		"indentation",
 		"info",

packages/MarkdownEditor-Parsing.package/MarkdownImage.class/README.md

@@ -1,3 +1 @@
-A MarkdownImage represents an image after parsing.
-
-Instance Variables
+A MarkdownImage represents an image after parsing.

packages/MarkdownEditor-Parsing.package/MarkdownImage.class/properties.json

@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "mf 8/4/2021 16:52",
+	"commentStamp" : "jh 8/5/2021 08:53",
 	"instvars" : [
 		 ],
 	"name" : "MarkdownImage",