Updated Kernel Library package documentation consistent with KerML spec.

seidewitz · seidewitz · commit a7b819b153c1 · 2021-10-17T16:15:25.000-04:00
- Corresponding to spec updates made for ST4MD-212.
diff --git a/sysml.library/Kernel Library/BaseFunctions.kerml b/sysml.library/Kernel Library/BaseFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines a basic set of functions defined on all kinds of values. 
+ * Most correspond to similarly named operators in the KerML expression syntax.
+ */
 package BaseFunctions {
 	private import Base::Anything;
 	private import Objects::Object;
diff --git a/sysml.library/Kernel Library/BooleanFunctions.kerml b/sysml.library/Kernel Library/BooleanFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines functions on Boolean values, including those corresponding to 
+ * (non-conditional) logical operators in the KerML expression notation.
+ */
 package BooleanFunctions {
 	import ScalarValues::*;
 	
diff --git a/sysml.library/Kernel Library/CollectionFunctions.kerml b/sysml.library/Kernel Library/CollectionFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines functions on Collections (as defined in the Collections package). 
+ * For functions on general sequences of values, see the SequenceFunctions package.
+ */
 package CollectionFunctions {
 	private import Base::Anything;
 	private import ScalarValues::*;
diff --git a/sysml.library/Kernel Library/Collections.kerml b/sysml.library/Kernel Library/Collections.kerml
@@ -1,3 +1,8 @@
+/**
+ * This package defines a standard set of Collection data types. Unlike sequences of values 
+ * defined directly using multiplicity, these data types allow for the possibility of collections 
+ * as elements of collections.
+ */
 package Collections {
 	private import Base::*;
 	private import ScalarValues::*;
diff --git a/sysml.library/Kernel Library/ComplexFunctions.kerml b/sysml.library/Kernel Library/ComplexFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines functions on Complex values, including concrete specializations of the 
+ * general arithmetic and comparison operations.
+ */
 package ComplexFunctions {
 	import ScalarValues::*;
 		
diff --git a/sysml.library/Kernel Library/ControlFunctions.kerml b/sysml.library/Kernel Library/ControlFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines functions that correspond to operators in the KerML expression notation 
+ * for which one or more operands are expressions whose evaluation is determined by another operand.
+ */
 package ControlFunctions {
 	private import Base::Anything;
 	private import ScalarValues::ScalarValue;
diff --git a/sysml.library/Kernel Library/ControlPerformances.kerml b/sysml.library/Kernel Library/ControlPerformances.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines Behaviors to be used to type Steps that control the sequencing of performance
+ * of other Steps. 
+ */
 package ControlPerformances {
 	private import ScalarValues::Boolean;
 	private import SequenceFunctions::size;
@@ -28,7 +32,7 @@ package ControlPerformances {
 	 * target the MergePerforance behavior. All such Successions must subset the incomingHBLink
 	 * feature of the target MergePerformance. For each instance of MergePerformance, the
 	 * incomingHBLink is an instance of exactly one of the Successions, ordering the
-	 * MergePerformance as happening after an instance of the source of that Succcession.
+	 * MergePerformance as happening after an instance of the source of that Succession.
 	 */
 	behavior MergePerformance specializes Performance {
 		/**
@@ -58,7 +62,7 @@ package ControlPerformances {
 	}
 	
 	/**
-	 * An IfElsePerformance is an IfPerformance where the elseCaluse occurs after and only 
+	 * An IfElsePerformance is an IfPerformance where the elseClause occurs after and only 
 	 * after the ifTest evaluation result is not true.
 	 */
 	behavior IfElsePerformance specializes IfPerformance {
diff --git a/sysml.library/Kernel Library/DataFunctions.kerml b/sysml.library/Kernel Library/DataFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines the abstract base functions corresponding to all the unary and binary operators 
+ * in the KerML expression notation that might be defined on various kinds of DataValues.
+ */
 package DataFunctions {
 	private import Base::DataValue;
 	private import ScalarValues::Boolean;
diff --git a/sysml.library/Kernel Library/FeatureAccessPerformances.kerml b/sysml.library/Kernel Library/FeatureAccessPerformances.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines Behaviors used to read and write values of a referenced Feature of an Occurrence 
+ * as of the time the Performance of the Behavior ends.
+ */
 package FeatureAccessPerformances {
 	private import Base::Anything;
 	private import Base::things;
diff --git a/sysml.library/Kernel Library/IntegerFunctions.kerml b/sysml.library/Kernel Library/IntegerFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines functions on Integer values, including concrete specializations of the 
+ * general arithmetic and comparison operations.
+ */
 package IntegerFunctions {
 	import ScalarValues::*;
 	
diff --git a/sysml.library/Kernel Library/KerML.kerml b/sysml.library/Kernel Library/KerML.kerml
@@ -1,3 +1,9 @@
+/**
+ * This package contains a reflective KerML model of the KerML abstract syntax.
+ * 
+ * NOTE: This model is currently incomplete. It includes all KerML abstract syntax metaclasses,
+ * but none of their properties.
+ */
 package KerML {
 	
 	struct Element;
diff --git a/sysml.library/Kernel Library/NaturalFunctions.kerml b/sysml.library/Kernel Library/NaturalFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines functions on Natural values, including concrete specialization of the 
+ * general arithmetic and comparison operations.
+ */
 package NaturalFunctions {
 	import ScalarValues::*;
 	
diff --git a/sysml.library/Kernel Library/NumericalFunctions.kerml b/sysml.library/Kernel Library/NumericalFunctions.kerml
@@ -1,3 +1,6 @@
+/**
+ * This package defines abstract functions on Numerical values for general arithmetic and comparison operations.
+ */
 package NumericalFunctions {
 	import ScalarValues::*;
 	
diff --git a/sysml.library/Kernel Library/Objects.kerml b/sysml.library/Kernel Library/Objects.kerml
@@ -1,5 +1,5 @@
 /**
- * This package defines classifiers and features that are related to the typing of objects and links.
+ * This package defines classifiers and features that are related to the typing of objects, including link objects.
  */
 package Objects {
 	private import Base::Anything;
diff --git a/sysml.library/Kernel Library/RationalFunctions.kerml b/sysml.library/Kernel Library/RationalFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines Functions on Rational values, including concrete specializations of the 
+ * general arithmetic and comparison operations.
+ */
 package RationalFunctions {
 	import ScalarValues::*;
 	
diff --git a/sysml.library/Kernel Library/RealFunctions.kerml b/sysml.library/Kernel Library/RealFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines Functions on Real values, including concrete specializations of the 
+ * general arithmetic and comparison operations.
+ */
 package RealFunctions {
 	import ScalarValues::*;
 	
diff --git a/sysml.library/Kernel Library/ScalarFunctions.kerml b/sysml.library/Kernel Library/ScalarFunctions.kerml
@@ -1,3 +1,6 @@
+/**
+ * This package defines abstract functions that specialize the DataFunctions for use with ScalarValues. 
+ */
 package ScalarFunctions {
 	import ScalarValues::*;
 	private import ControlFunctions::reduce;
diff --git a/sysml.library/Kernel Library/ScalarValues.kerml b/sysml.library/Kernel Library/ScalarValues.kerml
@@ -1,3 +1,8 @@
+/**
+ * This package contains a basic set of primitive scalar (non-collection) data types. 
+ * These include Boolean and String types and a hierarchy of concrete Number types, from 
+ * the most general type of Complex numbers to the most specific type of Positive integers.</p>
+ */
 package ScalarValues {
 	private import Base::DataValue;
 	
diff --git a/sysml.library/Kernel Library/SequenceFunctions.kerml b/sysml.library/Kernel Library/SequenceFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines functions that operate on general sequences of values. (For functions that
+ * operate on Collection values, see CollectionFunctions.)
+ */
 package SequenceFunctions {
 	private import Base::Anything;
 	private import ScalarValues::*;
diff --git a/sysml.library/Kernel Library/StatePerformances.kerml b/sysml.library/Kernel Library/StatePerformances.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package contains a library model of the semantics of state-based behavior,
+ * including the performance of (behavioral) states and the transitions between them.
+ */
 package StatePerformances {
 	private import ScalarValues::Boolean;
 	private import TransitionPerformances::TransitionPerformance;
diff --git a/sysml.library/Kernel Library/StringFunctions.kerml b/sysml.library/Kernel Library/StringFunctions.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package defines functions on String values, including those corresponding to string concatenation 
+ * and comparison operators in the KerML expression notation.
+ */
 package StringFunctions {
 	import ScalarValues::*;
 	
@@ -13,5 +17,7 @@ package StringFunctions {
 
 	function '==' specializes DataFunctions::'==' (x: String[0..1], y: String[0..1]): Boolean[1];
 	
-	function ToString specializes BaseFunctions::ToString (x: String[1]): String[1];	
+	function ToString specializes BaseFunctions::ToString (x: String[1]): String[1] {
+		x
+	}
 }
diff --git a/sysml.library/Kernel Library/TransitionPerformances.kerml b/sysml.library/Kernel Library/TransitionPerformances.kerml
@@ -1,3 +1,7 @@
+/**
+ * This package contains a library model of the semantics of conditional transitions between occurrences, 
+ * including the performance of specified Behaviors when the transition occurs.
+ */
 package TransitionPerformances {
 	private import ScalarValues::Boolean;
 	private import Occurrences::HappensBefore;
