- remove irrelevant and often wrong information from some description…

… strings

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

Compiler/BackEnd/BackendDAECreate.mo

@@ -3509,8 +3509,7 @@ algorithm
   end match;
 end findZeroCrossings1;
 
-protected function findZeroCrossings2 "function: findZeroCrossings2
-
+protected function findZeroCrossings2 "
   Helper function to find_zero_crossing.
   modified: 2011-01 by wbraun
 "
@@ -3923,8 +3922,7 @@ algorithm
   end matchcontinue;
 end collectZC;
 
-protected function collectZCAlgs "function: collectZeroCrossings
-
+protected function collectZCAlgs "
   Collects zero crossings in algorithms stamts, beside for loops those are
   processed by collectZCAlgsFor
 
@@ -4398,8 +4396,7 @@ algorithm
   end matchcontinue;
 end mergeZeroCrossings;
 
-protected function mergeZeroCrossing "function: mergeZeroCrossing
-
+protected function mergeZeroCrossing "
   Merges two zero crossings into one by makeing the union of the lists of
   equaions and when clauses they appear in.
   modified: 2011-01 by wbraun
@@ -4436,8 +4433,7 @@ algorithm
   end matchcontinue;
 end mergeZeroCrossing;
 
-protected function sameZeroCrossing "function: sameZeroCrossing
-
+protected function sameZeroCrossing "
   Returns true if both zero crossings have the same function expression
 "
   input BackendDAE.ZeroCrossing inZeroCrossing1;
@@ -4472,8 +4468,7 @@ algorithm
   end match;
 end sameZeroCrossing;
 
-protected function differentZeroCrossing "function: differentZeroCrossing
-
+protected function differentZeroCrossing "
   Return true if the realation expressions differ.
 "
   input BackendDAE.ZeroCrossing zc1;

Compiler/BackEnd/BackendDAEOptimize.mo

@@ -322,9 +322,7 @@ end lateInlineFunction;
 // remove simply equations stuff
 //
 // =============================================================================
-// protected function updateEquationSystemMatching
-// " function: updateEquationSystemMatching
-//   author: Frenkel TUD 2012-09"
+// protected function updateEquationSystemMatching "author: Frenkel TUD 2012-09"
 //   input BackendDAE.Variables ordvars;
 //   input BackendDAE.EquationArray eqns;
 //   input array<Integer> ass1 "ass[varindx]=eqnindx";
@@ -373,8 +371,7 @@ end lateInlineFunction;
 // end updateEquationSystemMatching;
 
 // protected function updateStrongComponent
-// " function: updateStrongComponent
-//   author: Frenkel TUD 2012-09"
+// "//   author: Frenkel TUD 2012-09"
 //   input BackendDAE.StrongComponent iComp;
 //   input array<Integer> varindxs;
 //   input array<Integer> eqnindxs;
@@ -529,8 +526,7 @@ algorithm
 end updateTornSystemComp;
 
 // protected function updateVarArray
-// " function: updateVarArray
-//   author: Frenkel TUD 2012-09"
+// "//   author: Frenkel TUD 2012-09"
 //   input Integer index;
 //   input Integer numberOfElement;
 //   input Integer insertindex;
@@ -590,8 +586,7 @@ end updateTornSystemComp;
 // end updateVarArray;
 
 // protected function updateEquationArray
-// " function: updateEquationArray
-//   author: Frenkel TUD 2012-09"
+// "//   author: Frenkel TUD 2012-09"
 //   input Integer index;
 //   input Integer numberOfElement;
 //   input Integer insertindex;
@@ -642,8 +637,7 @@ end updateTornSystemComp;
 // end updateEquationArray;
 
 protected function traverseIncidenceMatrix
-" function: traverseIncidenceMatrix
-  author: Frenkel TUD 2010-12"
+"  author: Frenkel TUD 2010-12"
   replaceable type Type_a subtypeof Any;
   input BackendDAE.IncidenceMatrix inM;
   input FuncType func;
@@ -659,8 +653,7 @@ algorithm
 end traverseIncidenceMatrix;
 
 protected function traverseIncidenceMatrix1
-" function: traverseIncidenceMatrix1
-  author: Frenkel TUD 2010-12"
+"  author: Frenkel TUD 2010-12"
   replaceable type Type_a subtypeof Any;
   input BackendDAE.IncidenceMatrix inM;
   input FuncType func;
@@ -678,8 +671,7 @@ algorithm
 end traverseIncidenceMatrix1;
 
 protected function traverseIncidenceMatrix2
-" function: traverseIncidenceMatrix1
-  author: Frenkel TUD 2010-12"
+"  author: Frenkel TUD 2010-12"
   replaceable type Type_a subtypeof Any;
   input BackendDAE.IncidenceMatrix inM;
   input FuncType func;
@@ -716,8 +708,7 @@ algorithm
 end traverseIncidenceMatrix2;
 
 protected function traverseIncidenceMatrixList
-" function: traverseIncidenceMatrixList
-  author: Frenkel TUD 2011-04"
+"  author: Frenkel TUD 2011-04"
   replaceable type Type_a subtypeof Any;
   input list<Integer> inLst "elements to traverse";
   input BackendDAE.IncidenceMatrix inM;
@@ -869,8 +860,7 @@ algorithm
 end countSimpleEquationsFinder;
 
 protected function countsimpleEquation
-" function: countsimpleEquation
-  author: Frenkel TUD 2011-05"
+"  author: Frenkel TUD 2011-05"
   input BackendDAE.IncidenceMatrixElement elem;
   input Integer length;
   input Integer pos;
@@ -1045,8 +1035,7 @@ algorithm
 end removeParametersFinder;
 
 protected function replaceFinalVars
-" function: replaceFinalVars
-  author: Frenkel TUD 2011-04"
+"  author: Frenkel TUD 2011-04"
   input Integer inNumRepl;
   input BackendDAE.Variables inVars;
   input BackendVarTransform.VariableReplacements inRepl;

Compiler/BackEnd/BackendDAEUtil.mo

@@ -486,8 +486,7 @@ algorithm
 end copyBackendDAE;
 
 public  function copyBackendDAEEqSystem
-" function: copyBackendDAE
-  author: Frenkel TUD, wbraun
+"  author: Frenkel TUD, wbraun
   Copy the dae to avoid changes in
   vectors."
   input BackendDAE.EqSystem inSysts;
@@ -519,8 +518,7 @@ algorithm
 end copyBackendDAEEqSystem;
 
 public  function copyBackendDAEShared
-" function: copyBackendDAEShared
-  author: Frenkel TUD, wbraun
+"  author: Frenkel TUD, wbraun
   Copy the shared part of an BackendDAE to avoid changes in
   vectors."
   input BackendDAE.Shared inShared;
@@ -577,8 +575,7 @@ algorithm
 end copyMatching;
 
 public function addBackendDAESharedJacobian
-" function: addBackendDAESharedJacobian
-  author:  wbraun"
+"  author:  wbraun"
   input BackendDAE.SymbolicJacobian inSymJac;
   input BackendDAE.SparsePattern inSparsePattern;
   input BackendDAE.SparseColoring inSparseColoring;
@@ -608,8 +605,7 @@ algorithm
 end addBackendDAESharedJacobian;
 
 public function addBackendDAESharedJacobians
-" function: addBackendDAESharedJacobians
-  author:  wbraun"
+"  author:  wbraun"
   input BackendDAE.SymbolicJacobians inSymJac;
   input BackendDAE.Shared inShared;
   output BackendDAE.Shared outShared;
@@ -635,8 +631,7 @@ algorithm
 end addBackendDAESharedJacobians;
 
 public function addBackendDAESharedJacobianSparsePattern
-" function: addBackendDAESharedJacobianSparsePattern
-  author:  wbraun"
+"  author:  wbraun"
   input BackendDAE.SparsePattern inSparsePattern;
   input BackendDAE.SparseColoring inSparseColoring;
   input Integer inIndex;
@@ -668,8 +663,7 @@ algorithm
 end addBackendDAESharedJacobianSparsePattern;
 
 public function addBackendDAEKnVars
-" function: addBackendDAEKnVars
-  That function replace the KnownVars in BackendDAE.
+"  That function replace the KnownVars in BackendDAE.
   author:  wbraun"
   input BackendDAE.Variables inKnVars;
   input BackendDAE.BackendDAE inBDAE;
@@ -695,8 +689,7 @@ algorithm
 end addBackendDAEKnVars;
 
 public function addBackendDAEFunctionTree
-" function: addBackendDAEFunctionTree
-  That function replace the FunctionTree in BackendDAE.
+"  That function replace the FunctionTree in BackendDAE.
   author:  wbraun"
   input DAE.FunctionTree inFunctionTree;
   input BackendDAE.BackendDAE inBDAE;
@@ -1297,8 +1290,7 @@ algorithm
   end matchcontinue;
 end isDiscreteEquation;
 
-public function isDiscreteExp "function: isDiscreteExp
- Returns true if expression is a discrete expression."
+public function isDiscreteExp " Returns true if expression is a discrete expression."
   input DAE.Exp inExp;
   input BackendDAE.Variables inVariables;
   input BackendDAE.Variables knvars;
@@ -1318,8 +1310,7 @@ algorithm
   end match;
 end isDiscreteExp;
 
-protected function isDiscreteExp1 "function: isDiscreteExp1
- Returns true if expression is a discrete expression."
+protected function isDiscreteExp1 " Returns true if expression is a discrete expression."
   input tuple<DAE.Exp,tuple<BackendDAE.Variables,BackendDAE.Variables,Boolean>> inExp;
   output tuple<DAE.Exp,tuple<BackendDAE.Variables,BackendDAE.Variables,Boolean>> outExp;
 algorithm
@@ -6517,8 +6508,7 @@ algorithm
   end matchcontinue;
 end rhsConstant2;
 
-// protected function freeFromAnyVar "function: freeFromAnyVar
-//   author: PA
+// protected function freeFromAnyVar "//   author: PA
 //   Helper function to rhsConstant2
 //   returns true if expression does not contain
 //   anyof the variables passed as argument."
@@ -7476,8 +7466,7 @@ algorithm
  end match;
 end traverseBackendDAEAttrDistribution;
 
-// protected function traverseBackendDAEExpsSubscript "function: traverseBackendDAEExpsSubscript
-//   author: Frenkel TUD
+// protected function traverseBackendDAEExpsSubscript "//   author: Frenkel TUD
 //   helper for traverseBackendDAEExpsSubscript"
 //   replaceable type Type_a subtypeof Any;
 //   input DAE.Subscript inSubscript;
@@ -7690,8 +7679,7 @@ algorithm
   end match;
 end traverseBackendDAEExpsOptEqnWithUpdate;
 
-public function traverseAlgorithmExps "function: traverseAlgorithmExps
-
+public function traverseAlgorithmExps "
   This function goes through the Algorithm structure and finds all the
   expressions and performs the function on them
 "
@@ -7717,8 +7705,7 @@ algorithm
   end match;
 end traverseAlgorithmExps;
 
-public function traverseAlgorithmExpsWithUpdate "function: traverseAlgorithmExpsWithUpdate
-
+public function traverseAlgorithmExpsWithUpdate "
   This function goes through the Algorithm structure and finds all the
   expressions and performs the function on them
 "
@@ -7833,8 +7820,7 @@ partial function stateDeselectionFunc
 end stateDeselectionFunc;
 
 public function getSolvedSystem
-" function: getSolvedSystem
-  Run the equation system pipeline."
+"  Run the equation system pipeline."
   input BackendDAE.BackendDAE inDAE;
   input Option<list<String>> strPreOptModules;
   input Option<String> strmatchingAlgorithm;
@@ -8301,8 +8287,7 @@ end pastoptimiseDAE;
 // end countComponents;
 
 public function getSolvedSystemforJacobians
-" function: getSolvedSystemforJacobians
-  Run the equation system pipeline."
+"  Run the equation system pipeline."
   input BackendDAE.BackendDAE inDAE;
   input Option<list<String>> strPreOptModules;
   input Option<String> strmatchingAlgorithm;

Compiler/BackEnd/BackendDump.mo

@@ -550,8 +550,7 @@ algorithm
 end dumpEquation;
 
 public function dumpTearing
-" function: dumpTearing
-  author: Frenkel TUD
+"  author: Frenkel TUD
   Dump tearing vars and residual equations."
   input list<list<Integer>> inResEqn;
   input list<list<Integer>> inTearVar;
@@ -1723,8 +1722,7 @@ algorithm
   end matchcontinue;
 end printCallFunction2StrDIVISION;
 
-// protected function printVarsStatistics "function: printVarsStatistics
-//   author: PA
+// protected function printVarsStatistics "//   author: PA
 // 
 //   Prints statistics on variables, etc.
 // "

Compiler/BackEnd/BackendEquation.mo

@@ -1738,8 +1738,7 @@ algorithm
 end equationRemove;
 
 public function compressEquations
-" function: compressEquations
-  author: Frenkel TUD 2012-11
+"  author: Frenkel TUD 2012-11
   Closes the gabs "
   input BackendDAE.EquationArray inEquationArray;
   output BackendDAE.EquationArray outEquationArray;
@@ -1762,8 +1761,7 @@ algorithm
 end compressEquations;
 
 protected function compressEquations1
-" function: compressEquations1
-  author: Frenkel TUD 2012-09"
+"  author: Frenkel TUD 2012-09"
   input Integer index;
   input Integer nEqns;
   input array<Option<BackendDAE.Equation>> equOptArr;

Compiler/BackEnd/BackendQSS.mo

@@ -123,8 +123,7 @@ algorithm
 end generateStructureCodeQSS;
 
 public function getAllVars
-"function: getAllVars
- outputs a list with all variables and the subset of state variables contained in DAELow
+" outputs a list with all variables and the subset of state variables contained in DAELow
  author: XF
 "
   input BackendDAE.BackendDAE inDAELow1;
@@ -151,8 +150,7 @@ algorithm
 end getAllVars;
 
 public function getStateIndices
-"function: getStateIndices
- finds the indices of the state indices inside a list with variables.
+" finds the indices of the state indices inside a list with variables.
  author: XF
 "
   input list<BackendDAE.Var> allVars;
@@ -193,8 +191,7 @@ algorithm
 end getStateIndices;
 
 public function getDiscreteIndices
-"function: getDiscreteIndices
- finds the indices of the state indices inside a list with variables.
+" finds the indices of the state indices inside a list with variables.
  author: XF
 "