more documentation for getComponentsTest (#7594) (#7616)

OpenModelica · Jun 26, 2021 · 4aa7a00 · 4aa7a00
1 parent 8db9243
commit 4aa7a00
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 20 deletions.
diff --git a/OMCompiler/Compiler/FrontEnd/ModelicaBuiltin.mo b/OMCompiler/Compiler/FrontEnd/ModelicaBuiltin.mo
@@ -3786,22 +3786,22 @@ annotation(
   preferredView="text");
 end getInheritedClasses;
 
-function getComponentsTest
+function getComponentsTest "returns an array of records with information about the components of the given class"
   input TypeName name;
   output Component[:] components;
   record Component
-    String className; // when building record the constructor. Records are allowed to contain only components of basic types, arrays of basic types or other records.
-    String name;
-    String comment;
-    Boolean isProtected;
-    Boolean isFinal;
-    Boolean isFlow;
-    Boolean isStream;
-    Boolean isReplaceable;
+    String className "the type of the component";
+    String name "the name of the component";
+    String comment "the comment of the component";
+    Boolean isProtected "true if component is protected";
+    Boolean isFinal "true if component is final";
+    Boolean isFlow "true if component is flow";
+    Boolean isStream "true if component is stream";
+    Boolean isReplaceable "true if component is replaceable";
     String variability "'constant', 'parameter', 'discrete', ''";
     String innerOuter "'inner', 'outer', ''";
     String inputOutput "'input', 'output', ''";
-    String dimensions[:];
+    String dimensions[:] "array with the dimensions of the component";
   end Component;
 external "builtin";
 annotation(Documentation(info="<html>

diff --git a/OMCompiler/Compiler/NFFrontEnd/NFModelicaBuiltin.mo b/OMCompiler/Compiler/NFFrontEnd/NFModelicaBuiltin.mo
@@ -3993,22 +3993,22 @@ annotation(
   preferredView="text");
 end getInheritedClasses;
 
-function getComponentsTest
+function getComponentsTest "returns an array of records with information about the components of the given class"
   input TypeName name;
   output Component[:] components;
   record Component
-    String className; // when building record the constructor. Records are allowed to contain only components of basic types, arrays of basic types or other records.
-    String name;
-    String comment;
-    Boolean isProtected;
-    Boolean isFinal;
-    Boolean isFlow;
-    Boolean isStream;
-    Boolean isReplaceable;
+    String className "the type of the component";
+    String name "the name of the component";
+    String comment "the comment of the component";
+    Boolean isProtected "true if component is protected";
+    Boolean isFinal "true if component is final";
+    Boolean isFlow "true if component is flow";
+    Boolean isStream "true if component is stream";
+    Boolean isReplaceable "true if component is replaceable";
     String variability "'constant', 'parameter', 'discrete', ''";
     String innerOuter "'inner', 'outer', ''";
     String inputOutput "'input', 'output', ''";
-    String dimensions[:];
+    String dimensions[:] "array with the dimensions of the component";
   end Component;
 external "builtin";
 annotation(Documentation(info="<html>