Doc fixes

git-svn-id: https://openmodelica.org/svn/OpenModelica/trunk@266 f25d12d1-65f4-0310-ae8a-bbce733d8d8e

Author: x97davka

modeq/absyn.rml

@@ -10,44 +10,43 @@ module Absyn:
   with "exp.rml"
   with "types.rml"
 
-(** These types are imported from other modules and given unqualified *)
-(** names to help the readibility, and for backwards compatibility *)
-(** with older versions.  This should be changed. *)
+  (** - Imported types *)
+  (** These types are imported from other modules and given unqualified *)
+  (** names to help the readibility, and for backwards compatibility *)
+  (** with older versions.  This should be changed. *)
 
   type Ident = Exp.Ident
   type Path = Exp.Path
   type Subscript = Exp.Subscript
   type ClassRestriction = Types.Restriction
 
-(**  Types
- **
- ** A program is simply a list of class definitions declared at top
- ** level in the source file.
- **)
-
+  (** - Programs *)
   type Program = Class list
+  (** A program is simply a list of class definitions declared at top
+   ** level in the source file.
+   **)
 
-(** A class definition consists of a name, a flag to indicate if this *)
-(** class is declared as `partial', the declared class restriction, *)
-(** and the body of the declaration. *)
-
+  (** - Classes *)
   datatype Class = CLASS of Ident		     (* Name *)
 			  * bool		     (* Partial *)
 			  (* FIXME: final *)
 			  * ClassRestriction	     (* Restricion *)
 			  * ClassDef		     (* Body *)
+  (** A class definition consists of a name, a flag to indicate if this *)
+  (** class is declared as `partial', the declared class restriction, *)
+  (** and the body of the declaration. *)
 
-(** The `ClassDef' type contains the definition part of a class *)
-(** declaration.  The definition is either explicit, with a list of *)
-(** parts (`public', `protected', `equation' and `algorithm'), or it *)
-(** is a definition derived from another class.  In the latter case *)
-(** this types contains the name of the derived class and an optional *)
-(** array dimension and a list of modifications. *)
 
   datatype ClassDef = PARTS of ClassPart list
 		    | DERIVED of Path
 			       * Types.ArrayDim option
 			       * ElementArg list
+  (** The `ClassDef' type contains the definition part of a class *)
+  (** declaration.  The definition is either explicit, with a list of *)
+  (** parts (`public', `protected', `equation' and `algorithm'), or it *)
+  (** is a definition derived from another class.  In the latter case *)
+  (** this types contains the name of the derived class and an optional *)
+  (** array dimension and a list of modifications. *)
 
   datatype ClassPart = PUBLIC of Element list
 		     | PROTECTED of Element list

modeq/builtin.rml

@@ -1,3 +1,10 @@
+(** file: builtin.rml *)
+
+(** - Module header
+ **
+ ** The only exported relation is `initial_env'.
+ **)
+
 module Builtin:
 
   with "absyn.rml"
@@ -15,11 +22,15 @@ module Builtin:
 
 end
 
+(**)
+
 with "exp.rml"
 with "types.rml"
 with "mod.rml"
 with "classinf.rml"
 
+(** - The primitive types *)
+
 val rl_type = Explode.CLASS("RealType",false,ClassInf.R_PREDEFINED_REAL,
 			    Explode.PARTS([],[],[]))
 val int_type = Explode.CLASS("IntegerType",false,ClassInf.R_PREDEFINED_INT,
@@ -29,6 +40,8 @@ val str_type = Explode.CLASS("StringType",false,ClassInf.R_PREDEFINED_STRING,
 val bool_type = Explode.CLASS("BooleanType",false,ClassInf.R_PREDEFINED_BOOL,
 			      Explode.PARTS([],[],[]))
 
+(** - The `Real' type *)
+
 val real_type =
 Explode.CLASS("Real",false,ClassInf.R_PREDEFINED_REAL,
 	      Explode.PARTS
@@ -55,6 +68,8 @@ Explode.CLASS("Real",false,ClassInf.R_PREDEFINED_REAL,
 	       [],
 	       []))
 
+(** - The `Integer' type *)
+
 val integer_type =
 Explode.CLASS("Integer",false,ClassInf.R_PREDEFINED_INT,
 	      Explode.PARTS
@@ -81,6 +96,8 @@ Explode.CLASS("Integer",false,ClassInf.R_PREDEFINED_INT,
 	       [],
 	       []))
 
+(** - The `String' type *)
+
 val string_type =
 Explode.CLASS("String",false,ClassInf.R_PREDEFINED_STRING,
 	      Explode.PARTS
@@ -97,6 +114,8 @@ Explode.CLASS("String",false,ClassInf.R_PREDEFINED_STRING,
 	       [],
 	       []))
 
+(** - The `Boolean' type *)
+
 val boolean_type =
 Explode.CLASS("Boolean",false,ClassInf.R_PREDEFINED_BOOL,
 	      Explode.PARTS
@@ -114,6 +133,8 @@ Explode.CLASS("Boolean",false,ClassInf.R_PREDEFINED_BOOL,
 	       []))
 
 
+(** - Initial environment *)
+
 relation initial_env =
 
   rule	Env.open_scope(Env.empty_env) => env &

modeq/classinf.rml

@@ -229,18 +229,18 @@ end
 
 relation start : (Restriction, string) => State =
 
-  axiom	start (R_CLASS, s) => UNKNOWN(s)
-  axiom	start (R_MODEL, s) => MODEL(s)
-  axiom	start (R_RECORD, s) => RECORD(s)
-  axiom	start (R_BLOCK, s) => BLOCK(s)
-  axiom	start (R_CONNECTOR, s) => CONNECTOR(s)
-  axiom	start (R_TYPE, s) => TYPE(s)
-  axiom	start (R_PACKAGE, s) => PACKAGE(s)
-  axiom	start (R_FUNCTION, s) => FUNCTION(s)
-  axiom	start (R_PREDEFINED_INT, s) => TYPE_INTEGER(s)
-  axiom	start (R_PREDEFINED_REAL, s) => TYPE_REAL(s)
+  axiom	start (R_CLASS, s) 	       => UNKNOWN(s)
+  axiom	start (R_MODEL, s) 	       => MODEL(s)
+  axiom	start (R_RECORD, s)            => RECORD(s)
+  axiom	start (R_BLOCK, s)             => BLOCK(s)
+  axiom	start (R_CONNECTOR, s)         => CONNECTOR(s)
+  axiom	start (R_TYPE, s)              => TYPE(s)
+  axiom	start (R_PACKAGE, s)           => PACKAGE(s)
+  axiom	start (R_FUNCTION, s)          => FUNCTION(s)
+  axiom	start (R_PREDEFINED_INT, s)    => TYPE_INTEGER(s)
+  axiom	start (R_PREDEFINED_REAL, s)   => TYPE_REAL(s)
   axiom	start (R_PREDEFINED_STRING, s) => TYPE_STRING(s)
-  axiom	start (R_PREDEFINED_BOOL, s) => TYPE_BOOL(s)
+  axiom	start (R_PREDEFINED_BOOL, s)   => TYPE_BOOL(s)
 
 end
 
@@ -293,7 +293,7 @@ relation trans : (State, Event) => State =
   axiom	trans(FUNCTION(s),       FOUND_EQUATION) => fail
   axiom	trans(HAS_EQUATIONS(s),  FOUND_EQUATION) => HAS_EQUATIONS(s)
 
-  rule	print "- trans fallthru: " & print_state st &
+  rule	print "- trans failed: " & print_state st &
  	print ", " & print_event ev & print "\n"
 	--------------------------------------------------------
 	trans(st, ev) => fail