backend: add documentation

LinqLover · Oct 5, 2023 · 75e8037 · 75e8037
1 parent 6bfd2a3
commit 75e8037
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 1 deletion.
diff --git a/packages/Trace4D.package/T4DTrace.class/README.md b/packages/Trace4D.package/T4DTrace.class/README.md
@@ -0,0 +1 @@
+I serialize a program trace from the TraceDebugger into a JSON file.
diff --git a/packages/Trace4D.package/T4DTrace.class/class/example.st b/packages/Trace4D.package/T4DTrace.class/class/example.st
@@ -0,0 +1,5 @@
+documentation
+example
+
+	(T4DTrace forBlock: ['\w|\d+' asRegex])
+		storeJsonInFileNamed: 'regexParse.json'.
diff --git a/packages/Trace4D.package/T4DTrace.class/class/exampleHistory.st b/packages/Trace4D.package/T4DTrace.class/class/exampleHistory.st
@@ -0,0 +1,6 @@
+documentation
+exampleHistory
+
+	(T4DTrace forBlock: ['\w|\d+' asRegex])
+		includesHistoricFields: true;
+		storeJsonInFileNamed: 'regexParse2.json'.
diff --git a/packages/Trace4D.package/T4DTrace.class/methodProperties.json b/packages/Trace4D.package/T4DTrace.class/methodProperties.json
@@ -1,6 +1,8 @@
 {
 	"class" : {
 		"cursorClass" : "ct 5/26/2023 00:40",
+		"example" : "ct 10/5/2023 19:32",
+		"exampleHistory" : "ct 10/5/2023 19:31",
 		"forBlock:" : "ct 5/21/2023 17:39",
 		"forCursor:" : "ct 5/21/2023 17:39" },
 	"instance" : {

diff --git a/packages/Trace4D.package/T4DTrace.class/properties.json b/packages/Trace4D.package/T4DTrace.class/properties.json
@@ -4,7 +4,7 @@
 		 ],
 	"classvars" : [
 		 ],
-	"commentStamp" : "",
+	"commentStamp" : "ct 10/5/2023 19:36",
 	"instvars" : [
 		"cursor",
 		"includesHistoricFields",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		I serialize a program trace from the TraceDebugger into a JSON file.