Added better comments

Author: Zaydek Michels-Gualtieri

src/Editor/model/Editor/Editor.js

@@ -1,7 +1,6 @@
 import Range from "./Range"
 import { immerable } from "immer"
 
-// Describes an editor.
 class Editor {
 	[immerable] = true
 

src/Editor/model/Editor/Element.js

@@ -1,7 +1,6 @@
 import hash from "lib/hash"
 import { immerable } from "immer"
 
-// Describes an element.
 class Element {
 	[immerable] = true
 

src/Editor/model/Editor/InlineElement.js

@@ -1,5 +1,11 @@
-// Describes an inline element.
+import { immerable } from "immer"
+
+// Describes an inline element, such as plaintext or rich
+// text. An inline element is considered discerete when
+// types and props are not equal.
 class InlineElement {
+	[immerable] = true
+
 	// Zero-to-many types.
 	types = []
 	// Zero-to-many props.

src/Editor/model/Editor/MultilineElement.js

@@ -1,22 +1,8 @@
 import hash from "lib/hash"
 import { immerable } from "immer"
 
-// Describes a multiline element.
-//
-// {
-//   props: {
-//     elements: [
-//       {
-//         props: {
-//           children: [
-//             ...
-//           ],
-//         },
-//       },
-//     ],
-//   },
-// }
-//
+// Describes an element that renders one or more sub-
+// elements, such as <pre>, <ul>, and <ol>.
 class MultilineElement {
 	[immerable] = true
 

src/Editor/model/Editor/Position.js

@@ -3,16 +3,16 @@ import {
 	produce,
 } from "immer"
 
-// Describes a position; a start and end position compose a
-// range.
+// Describes a position. A position corresponds to a user
+// insertion point.
 class Position {
 	[immerable] = true
 
 	key = ""
 	offset = ""
 
-	// Constructs from a position literal.
-	static fromLiteral({ node, offset }) {
+	// Constructs from a user literal.
+	static fromUserLiteral({ node, offset }) {
 		// ...
 	}
 
@@ -25,8 +25,8 @@ class Position {
 		return ok
 	}
 
-	// Converts to a position literal.
-	toLiteral() {
+	// Resolves to a user literal.
+	toUserLiteral() {
 		// ...
 	}
 }

src/Editor/model/Editor/Range.js

@@ -5,7 +5,8 @@ import {
 	produce,
 } from "immer"
 
-// Describes a range.
+// Describes a range. A range corresponds to the user
+// insertion point or selection.
 class Range {
 	[immerable] = true
 
@@ -37,8 +38,8 @@ class Range {
 		})
 	}
 
-	// Converts to a range literal.
-	toRangeLiteral() {
+	// Resolves to a user literal.
+	toUserLiteral() {
 		// ...
 	}
 }

src/Editor/model/Scanners/AbstractScanner.js

@@ -3,7 +3,8 @@ import Element from "../Editor/Element"
 import InlineElement from "../Editor/InlineElement"
 import JSONClone from "lib/JSONClone"
 
-// Describes an abstract scanner.
+// Describes an abstract scanner. AbstractScanner relies on
+// SemanticScanner and RenderedScanner.
 class AbstractScanner {
 	// Scans types and props.
 	scanner = null

src/Editor/model/Scanners/RenderedScanner.js

@@ -1,7 +1,7 @@
 import * as scanners from "./scanners"
 import AbstractScanner from "./AbstractScanner"
 
-// Describes a rendered reader; implements scan.
+// Describes a rendered scanner; implements scan.
 //
 // const scanner = new RenderedScanner()
 // scanner.scan(tree)

src/Editor/model/Scanners/SemanticScanner.js

@@ -1,7 +1,7 @@
 import * as scanners from "./scanners"
 import AbstractScanner from "./AbstractScanner"
 
-// Describes a semantic reader; implements scan.
+// Describes a semantic scanner; implements scan.
 //
 // const scanner = new SemanticScanner()
 // scanner.scan(tree)

src/Editor/model/Scanners/scanners.js

@@ -1,6 +1,6 @@
 import domUtils from "lib/domUtils"
 
-// Scanner for a rendered element; scans types and props.
+// Scanner for a rendered element; scans type and props.
 export function rendered(element) {
 	let T = ""
 	let P = {}
@@ -26,7 +26,7 @@ export function rendered(element) {
 	return [T, P]
 }
 
-// Scanner for a semantic element; scans types and props.
+// Scanner for a semantic element; scans type and props.
 export function semantic(element) {
 	let T = ""
 	let P = {}