Skip to content

Commit c5e0c5e

Browse files
committed
- remove irrelevant information from description strings (e.g. the identifier that belongs to the description string)
- minor changes to improve consistent formatting git-svn-id: https://openmodelica.org/svn/OpenModelica/trunk@16819 f25d12d1-65f4-0310-ae8a-bbce733d8d8e
1 parent 8af4966 commit c5e0c5e

File tree

13 files changed

+140
-136
lines changed

13 files changed

+140
-136
lines changed

Compiler/BackEnd/BackendDAE.mo

Lines changed: 83 additions & 79 deletions
Large diffs are not rendered by default.

Compiler/BackEnd/BackendDAEOptimize.mo

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7202,8 +7202,8 @@ algorithm
72027202
(osyst,osharedChanged) :=
72037203
matchcontinue(isyst,sharedChanged)
72047204
local
7205-
BackendDAE.Variables orderedVars "orderedVars ; ordered Variables, only states and alg. vars" ;
7206-
BackendDAE.EquationArray orderedEqs "orderedEqs ; ordered Equations" ;
7205+
BackendDAE.Variables orderedVars "ordered Variables, only states and alg. vars" ;
7206+
BackendDAE.EquationArray orderedEqs "ordered Equations" ;
72077207
Option<BackendDAE.IncidenceMatrix> m;
72087208
Option<BackendDAE.IncidenceMatrixT> mT;
72097209
BackendDAE.Matching matching;

Compiler/BackEnd/BinaryTree.mo

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ public
6161
uniontype BinTree "Generic Binary tree implementation
6262
- Binary Tree"
6363
record TREENODE
64-
Option<TreeValue> value "value ; Value" ;
65-
Option<BinTree> leftSubTree "leftSubTree ; left subtree" ;
66-
Option<BinTree> rightSubTree "rightSubTree ; right subtree" ;
64+
Option<TreeValue> value "Value" ;
65+
Option<BinTree> leftSubTree "left subtree" ;
66+
Option<BinTree> rightSubTree "right subtree" ;
6767
end TREENODE;
6868

6969
end BinTree;

Compiler/BackEnd/BinaryTreeInt.mo

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ public
5454
uniontype BinTree "Generic Binary tree implementation
5555
- Binary Tree"
5656
record TREENODE
57-
Option<TreeValue> value "value ; Value" ;
58-
Option<BinTree> leftSubTree "leftSubTree ; left subtree" ;
59-
Option<BinTree> rightSubTree "rightSubTree ; right subtree" ;
57+
Option<TreeValue> value "Value" ;
58+
Option<BinTree> leftSubTree "left subtree" ;
59+
Option<BinTree> rightSubTree "right subtree" ;
6060
end TREENODE;
6161

6262
end BinTree;

Compiler/BackEnd/Uncertainties.mo

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2014,16 +2014,16 @@ algorithm
20142014
list<BackendDAE.EqSystem> systList;
20152015
BackendDAE.Shared shared;
20162016

2017-
BackendDAE.Variables orderedVars "orderedVars ; ordered Variables, only states and alg. vars" ;
2018-
BackendDAE.EquationArray orderedEqs "orderedEqs ; ordered Equations" ;
2017+
BackendDAE.Variables orderedVars "ordered Variables, only states and alg. vars" ;
2018+
BackendDAE.EquationArray orderedEqs "ordered Equations" ;
20192019
Option<BackendDAE.IncidenceMatrix> m;
20202020
Option<BackendDAE.IncidenceMatrixT> mT;
20212021
BackendDAE.Matching matching;
20222022

2023-
BackendDAE.Variables knownVars "knownVars ; Known variables, i.e. constants and parameters" ;
2023+
BackendDAE.Variables knownVars "Known variables, i.e. constants and parameters" ;
20242024
BackendDAE.Variables externalObjects "External object variables";
20252025
BackendDAE.Variables aliasVars "mappings of alias-variables to real-variables"; // added asodja 2010-03-03
2026-
BackendDAE.EquationArray initialEqs "initialEqs ; Initial equations" ;
2026+
BackendDAE.EquationArray initialEqs "Initial equations" ;
20272027
BackendDAE.EquationArray removedEqs "these are equations that cannot solve for a variable. for example assertions, external function calls, algorithm sections without effect" ;
20282028
array<DAE.Constraint> constraints "constraints" ;
20292029
array<DAE.ClassAttributes> classAttrs;
@@ -2076,16 +2076,16 @@ algorithm
20762076
list<BackendDAE.EqSystem> systList;
20772077
BackendDAE.Shared shared;
20782078

2079-
BackendDAE.Variables orderedVars "orderedVars ; ordered Variables, only states and alg. vars" ;
2080-
BackendDAE.EquationArray orderedEqs "orderedEqs ; ordered Equations" ;
2079+
BackendDAE.Variables orderedVars "ordered Variables, only states and alg. vars" ;
2080+
BackendDAE.EquationArray orderedEqs "ordered Equations" ;
20812081
Option<BackendDAE.IncidenceMatrix> m;
20822082
Option<BackendDAE.IncidenceMatrixT> mT;
20832083
BackendDAE.Matching matching;
20842084

2085-
BackendDAE.Variables knownVars "knownVars ; Known variables, i.e. constants and parameters" ;
2085+
BackendDAE.Variables knownVars "Known variables, i.e. constants and parameters" ;
20862086
BackendDAE.Variables externalObjects "External object variables";
20872087
BackendDAE.Variables aliasVars "mappings of alias-variables to real-variables"; // added asodja 2010-03-03
2088-
BackendDAE.EquationArray initialEqs "initialEqs ; Initial equations" ;
2088+
BackendDAE.EquationArray initialEqs "Initial equations" ;
20892089
BackendDAE.EquationArray removedEqs "these are equations that cannot solve for a variable. for example assertions, external function calls, algorithm sections without effect" ;
20902090
array<DAE.Constraint> constraints "constraints" ;
20912091
array<DAE.ClassAttributes> classAttrs;
@@ -2345,10 +2345,10 @@ algorithm
23452345
BackendDAE.Shared shared;
23462346

23472347

2348-
BackendDAE.Variables knownVars "knownVars ; Known variables, i.e. constants and parameters" ;
2348+
BackendDAE.Variables knownVars "Known variables, i.e. constants and parameters" ;
23492349
BackendDAE.Variables externalObjects "External object variables";
23502350
BackendDAE.Variables aliasVars "mappings of alias-variables to real-variables"; // added asodja 2010-03-03
2351-
BackendDAE.EquationArray initialEqs "initialEqs ; Initial equations" ;
2351+
BackendDAE.EquationArray initialEqs "Initial equations" ;
23522352
BackendDAE.EquationArray removedEqs "these are equations that cannot solve for a variable. for example assertions, external function calls, algorithm sections without effect" ;
23532353
array<DAE.Constraint> constraints "constraints" ;
23542354
array<DAE.ClassAttributes> classAttrs;

Compiler/FrontEnd/Absyn.mo

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ uniontype Element "Elements
314314
InnerOuter innerOuter "inner/outer" ;
315315
ElementSpec specification "Actual element specification" ;
316316
Info info "File name the class is defined in + line no + column no" ;
317-
Option<ConstrainClass> constrainClass "constrainClass ; only valid for classdef and component" ;
317+
Option<ConstrainClass> constrainClass "only valid for classdef and component" ;
318318
end ELEMENT;
319319

320320
record DEFINEUNIT
@@ -334,7 +334,7 @@ end Element;
334334
public
335335
uniontype ConstrainClass "Constraining type, must be extends"
336336
record CONSTRAINCLASS
337-
ElementSpec elementSpec "elementSpec ; must be extends" ;
337+
ElementSpec elementSpec "must be extends" ;
338338
Option<Comment> comment "comment" ;
339339
end CONSTRAINCLASS;
340340

@@ -440,8 +440,8 @@ public
440440
uniontype Component "Some kind of Modelica entity (object or variable)"
441441
record COMPONENT
442442
Ident name "name" ;
443-
ArrayDim arrayDim "arrayDim ; Array dimensions, if any" ;
444-
Option<Modification> modification "modification ; Optional modification" ;
443+
ArrayDim arrayDim "Array dimensions, if any" ;
444+
Option<Modification> modification "Optional modification" ;
445445
end COMPONENT;
446446

447447
end Component;
@@ -480,8 +480,8 @@ public
480480
uniontype Equation "Information on one (kind) of equation, different constructors for different
481481
kinds of equations"
482482
record EQ_IF
483-
Exp ifExp "ifExp ; Conditional expression" ;
484-
list<EquationItem> equationTrueItems "equationTrueItems ; true branch" ;
483+
Exp ifExp "Conditional expression" ;
484+
list<EquationItem> equationTrueItems "true branch" ;
485485
list<tuple<Exp, list<EquationItem>>> elseIfBranches "elseIfBranches" ;
486486
list<EquationItem> equationElseItems "equationElseItems Standard 2-side eqn" ;
487487
end EQ_IF;
@@ -657,7 +657,7 @@ uniontype ElementAttributes "- Component attributes"
657657
// Boolean inner_ "inner";
658658
// Boolean outer_ "outer";
659659
Parallelism parallelism "for OpenCL/CUDA parglobal, parlocal ...";
660-
Variability variability "variability ; parameter, constant etc." ;
660+
Variability variability "parameter, constant etc." ;
661661
Direction direction "direction" ;
662662
ArrayDim arrayDim "arrayDim" ;
663663
end ATTR;

Compiler/FrontEnd/DAE.mo

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -733,7 +733,7 @@ uniontype Var "- Variables"
733733
Ident name "name";
734734
Attributes attributes "attributes";
735735
Type ty "type" ;
736-
Binding binding "binding ; equation modification";
736+
Binding binding "equation modification";
737737
Option<Const> constOfForIteratorRange "the constant-ness of the range if this is a for iterator, NONE() if is NOT a for iterator";
738738
end TYPES_VAR;
739739
end Var;
@@ -861,14 +861,14 @@ public uniontype Type "models the different front-end and back-end types"
861861
end T_UNKNOWN;
862862

863863
record T_COMPLEX
864-
ClassInf.State complexClassType "complexClassType ; The type of a class" ;
865-
list<Var> varLst "complexVarLst ; The variables of a complex type" ;
864+
ClassInf.State complexClassType "The type of a class" ;
865+
list<Var> varLst "The variables of a complex type" ;
866866
EqualityConstraint equalityConstraint;
867867
TypeSource source;
868868
end T_COMPLEX;
869869

870870
record T_SUBTYPE_BASIC
871-
ClassInf.State complexClassType "complexClassType ; The type of a class" ;
871+
ClassInf.State complexClassType "The type of a class" ;
872872
list<Var> varLst "complexVarLst; The variables of a complex type! Should be empty, kept here to verify!";
873873
Type complexType "complexType; A complex type can be a subtype of another (primitive) type (through extends)";
874874
EqualityConstraint equalityConstraint;
@@ -877,7 +877,7 @@ public uniontype Type "models the different front-end and back-end types"
877877

878878
record T_FUNCTION
879879
list<FuncArg> funcArg "funcArg" ;
880-
Type funcResultType "funcResultType ; Only single-result" ;
880+
Type funcResultType "Only single-result" ;
881881
FunctionAttributes functionAttributes;
882882
TypeSource source;
883883
end T_FUNCTION;
@@ -894,7 +894,7 @@ public uniontype Type "models the different front-end and back-end types"
894894
end T_FUNCTION_REFERENCE_FUNC;
895895

896896
record T_TUPLE
897-
list<Type> tupleType "tupleType ; For functions returning multiple values.";
897+
list<Type> tupleType "For functions returning multiple values.";
898898
TypeSource source;
899899
end T_TUPLE;
900900

@@ -1120,8 +1120,8 @@ uniontype EqMod "To generate the correct set of equations, the translator has to
11201120
type, and whether a variable is of one of these types.
11211121
- Modification datatype, was originally in Mod"
11221122
record TYPED
1123-
Exp modifierAsExp "modifierAsExp ; modifier as expression" ;
1124-
Option<Values.Value> modifierAsValue "modifierAsValue ; modifier as Value option" ;
1123+
Exp modifierAsExp "modifier as expression" ;
1124+
Option<Values.Value> modifierAsValue "modifier as Value option" ;
11251125
Properties properties "properties" ;
11261126
Option<Absyn.Exp> modifierAsAbsynExp "keep the untyped modifier as an absyn expression for modification comparison";
11271127
Absyn.Info info;

Compiler/FrontEnd/Inst.mo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9798,7 +9798,7 @@ algorithm
97989798
DAE.Attributes dae_attr;
97999799
SCode.Visibility visibility "protected/public";
98009800
DAE.Type ty "type";
9801-
DAE.Binding binding "binding ; equation modification";
9801+
DAE.Binding binding "equation modification";
98029802
Option<DAE.Const> cnstOpt "the constant-ness of the range if this is a for iterator, NONE() if is NOT a for iterator";
98039803
SCode.Mod smod;
98049804
DAE.Mod daeMod;

Compiler/FrontEnd/Static.mo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9973,7 +9973,7 @@ algorithm
99739973
SCode.Element cl;
99749974
DAE.FunctionBuiltin isBuiltin;
99759975
DAE.Attributes attr;
9976-
DAE.Binding binding "binding ; equation modification";
9976+
DAE.Binding binding "equation modification";
99779977
Env.Frame frame;
99789978

99799979
// wildcard

Compiler/FrontEnd/Types.mo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3792,7 +3792,7 @@ algorithm
37923792
String name;
37933793
DAE.Attributes attributes;
37943794
Type ty "type";
3795-
DAE.Binding binding "binding ; equation modification";
3795+
DAE.Binding binding "equation modification";
37963796
Option<DAE.Const> constOfForIteratorRange "the constant-ness of the range if this is a for iterator, NONE() if is NOT a for iterator";
37973797
list<DAE.Var> rest;
37983798

0 commit comments

Comments
 (0)