Documentation race again! Wohoo!

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

Author: Kaj Nyström

modeq/algorithm.rml

@@ -33,7 +33,8 @@
  ** processing of any kind, except for building the datastructure is 
  ** done in this module.
  ** 
- ** 
+ ** It is used primarily by inst.rml which both provides its input data
+ ** and uses its "output" data.
  ** 
  **)
 

modeq/classinf.rml

@@ -35,7 +35,7 @@
  ** relation `start' initializes a new machine, and the relation
  ** `trans' signals transitions in the machine.  Finally, the state
  ** can be checked agains a restriction with the `valid' relation.
- **
+ ** 
  **)
 
 module ClassInf :

modeq/classloader.rml

@@ -26,7 +26,11 @@
  **
  ** RCS: $Id$
  **
- ** This module loads classes from $MODELICAPATH.
+ ** This module loads classes from $MODELICAPATH. It exports only one
+ ** relation: the load_class relation. It is currently (2004-09-27) 
+ ** only used by ceval.rml when using the "loadclass" function in 
+ ** the interactive environment.
+ ** 
  **)
 
 module ClassLoader:
@@ -54,7 +58,7 @@ relation load_class: (Absyn.Path, string) => (Absyn.Program) =
 
 	(** Simple names: Just load the file if it can be found in $MODELICAPATH* *)
   rule System.group_delimiter => gd &	
-    System.strtok(mp,gd) => mps &
+	System.strtok(mp,gd) => mps &
 	load_class_from_mps(classname,mps) => p
 	-------------------------------------
 	load_class(Absyn.IDENT(classname),mp) => p
@@ -69,7 +73,7 @@ relation load_class: (Absyn.Path, string) => (Absyn.Program) =
 	(** Qualified names: Else, load the complete package and then check that **)
 	(** the package contains the file **) 
   rule	System.group_delimiter => gd &	
-    System.strtok(mp,gd) => mps &
+	System.strtok(mp,gd) => mps &
 	load_complete_package_from_mps(pack,mps,Absyn.TOP,Absyn.PROGRAM([],Absyn.TOP)) => p &
 	Interactive.get_pathed_class_in_program(path,p)=> _
 	-------------------------------------

modeq/connect.rml

@@ -26,11 +26,15 @@
  **
  ** RCS: $Id$
  **
- ** Connections generate connection sets which are constructed during
- ** instantiation.  When a connection set is generated, it is used to
- ** create a number of equations.
- **
- ** This module performs connection set management.
+ ** Connections generate connection sets (datatype SET is described below)
+ ** which are constructed during instantiation.  When a connection 
+ ** set is generated, it is used to create a number of equations. 
+ ** The kind of equations created depends on the type of the set. 
+ ** 
+ ** Connect.rml is called from inst.rml and is responsible for 
+ ** creation of all connect-equations later passed to the DAE module 
+ ** in dae.rml.
+ ** 
  **)
 
 module Connect :

modeq/corba.rml

@@ -23,9 +23,21 @@
  ** module:      Corba
  ** description: Modelica Corba communication module
  **
- ** RCS: %W %E
+ ** RCS: $Id$
  **
- ** This is the Corba connection module of the compiler
+ ** This is the CORBA connection module of the compiler
+ ** 
+ ** The actual implementation differs between Windows and Unix versions. 
+ ** The Windows implementation is located in ./winruntime and the Unix
+ ** version lies in ./runtime
+ ** 
+ ** OpenModelica does not in itself include a complete CORBA implementaton.
+ ** You need to download one, for example MICO from http://www.mico.org.
+ **
+ ** There exists some options that can be sent to configure concerinng 
+ ** the usage of corba: 
+ **    --with-CORBA=/location/of/corba/library
+ **    --without-CORBA
  **)
 
 module Corba:

modeq/dump.rml

@@ -32,14 +32,18 @@
  ** The implementation of the relations are excluded from the report,
  ** as they occupy a lot of space and do not convey any useful
  ** semantic information.
+ **
+ ** The main entrypoint for this module is the relation "dump" which
+ ** takes an entire program as an argument, and prints it all in
+ ** Modelica source form. The other interface relations can be used
+ ** to print smaller portions of a program.
  **)
 
 
 module Dump:
 
   with "absyn.rml"
   with "interactive.rml"							  
-  with "debug.rml"
 
   type Ident = string
 
@@ -88,6 +92,7 @@ with "classinf.rml"
 with "rtopts.rml"
 with "print.rml"
 with "util.rml"
+with "debug.rml"
 
 (* Relations *)
 

modeq/prefix.rml

@@ -26,9 +26,15 @@
  **
  ** RCS: $Id$
  **
- ** When instantiating an expression, there is a prefix that has to be
- ** added to each variable name to be able to use it in the flattened
- ** equation set. These relations take care of adding the prefixes.
+ ** When instantiating an expression, there is a prefix that *sometimes* 
+ ** has to be added to each variable name to be able to use it in the 
+ ** flattened equation set.
+ ** 
+ ** A prefix for a variable x could be for example a.b.c so that the 
+ ** fully qualified name is a.b.c.x. 
+ ** 
+ ** Some components should not have prefixes added, for example constants.
+ ** 
  **)
 
 module Prefix:
@@ -77,8 +83,7 @@ relation print_prefix_str : Prefix => string =
 
   rule	print_prefix_str rest => rest' &
 	string_append (rest', ".") => s &
-	string_append (s, str) => s' &
-	string_append (s', "[]") => s''
+	string_append (s, str) => s'	string_append (s', "[]") => s''
 	----------------------------
 	print_prefix_str PRE(str, _, rest) => s''
 
@@ -268,15 +273,12 @@ relation prefix_exp : (Env.Env,Exp.Exp,Prefix) => Exp.Exp =
 	-----------------------
 	prefix_exp(env,Exp.CALL(f,es,b,bi),p) => Exp.CALL(f,es',b,bi)
 
-	(**)
   axiom	prefix_exp(env,Exp.ARRAY(t,a,[]),p) => Exp.ARRAY(t,a,[])
 
   rule	prefix_exp_list(env,es,p) => es'
 	-------------------------------
 	prefix_exp(env,Exp.ARRAY(t,a,es),p) => Exp.ARRAY(t,a,es')
 
-
-(* PR. *)
   rule	prefix_exp_list(env,es,p) => es'
 	-------------------------------
 	prefix_exp(env,Exp.TUPLE(es),p) => Exp.TUPLE(es')

modeq/rtopts.rml

@@ -19,6 +19,22 @@
 
 *)
 
+(**
+ ** file:	 rtopts.rml
+ ** module:      RTOpts
+ ** description: Runtime options
+ **
+ ** RCS: $Id$
+ **
+ ** This module takes care of command line options. It is possible to 
+ ** ask it what flags are set, what arguments were given etc.
+ **  
+ ** This module is used pretty much everywhere where debug calls are made.
+ ** 
+ **)
+
+
+
 module RTOpts:
 
   relation args : string list => string list