documentation

Mathemodica · Dec 7, 2018 · a92b3a0 · a92b3a0
1 parent fc4fd08
commit a92b3a0
Show file tree

Hide file tree

Showing 15 changed files with 17 additions and 94 deletions.
diff --git a/Examples/package.mo b/Examples/package.mo
@@ -1,5 +1,5 @@
 within GenKinetics;
-package Examples
+package Examples "set of examples"
   extends Modelica.Icons.ExamplesPackage;
 
   model SpirallusLinLog "An abstraction of the TCA cycle with dynamic arbitrary number of connections implemented "
@@ -63,26 +63,6 @@ package Examples
 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 
   annotation (
     Documentation(info="<html>

diff --git a/Icons/package.mo b/Icons/package.mo
@@ -1,42 +1,9 @@
 within GenKinetics;
-package Icons
+package Icons "all icons used across the library"
   extends Modelica.Icons.IconsPackage;
 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
   annotation (
     Documentation(info="<html>
 <p>This subpackage contains basic icons to be reused acroos the library.&nbsp;</p>

diff --git a/Interfaces/package.mo b/Interfaces/package.mo
@@ -1,13 +1,9 @@
 within GenKinetics;
-package Interfaces
+package Interfaces "basic interfaces used across the library"
   extends Modelica.Icons.InterfacesPackage;
 
 
 
-
-
-
-
   annotation (
     Documentation(info="<html>
 <p>This package contains all interfaces, abstract models, connectors etc. utilized by the components throughout the library.</p>

diff --git a/Reactions/Convenience/Auto/InhIrrKinetic.mo b/Reactions/Convenience/Auto/InhIrrKinetic.mo
@@ -4,8 +4,7 @@ model InhIrrKinetic "S1 + S2 + ... ==I1,I2,...==> P1 + P2 + ... "
       replaceable model Modifiers = Convenience.InhibitionTerm (redeclare
           final model Activation =
             Interfaces.Reactions.Modifiers.Auto.NoActivation), redeclare final
-      model       Reversibility =
-                            Interfaces.Reactions.Reversible.OneWay);
+      model Reversibility = Interfaces.Reactions.Reversible.OneWay);
 
 equation
 

diff --git a/Reactions/Convenience/AutoTypes3/IrrUniBiI1.mo b/Reactions/Convenience/AutoTypes3/IrrUniBiI1.mo
@@ -1,7 +1,7 @@
 within GenKinetics.Reactions.Convenience.AutoTypes3;
 model IrrUniBiI1
   extends GenKinetics.Reactions.Convenience.Auto.InhIrrKinetic(redeclare final
-      model       Dimensionality =
+      model Dimensionality =
         GenKinetics.Interfaces.Reactions.Basics.Auto.Dimension.UniBi,
       redeclare final model Inhibition =
         GenKinetics.Interfaces.Reactions.Modifiers.Auto.Inhibitor);

diff --git a/Reactions/Convenience/AutoTypes3/IrrUniUniI1.mo b/Reactions/Convenience/AutoTypes3/IrrUniUniI1.mo
@@ -1,7 +1,7 @@
 within GenKinetics.Reactions.Convenience.AutoTypes3;
 model IrrUniUniI1
   extends GenKinetics.Reactions.Convenience.Auto.InhIrrKinetic(redeclare final
-      model       Dimensionality =
+      model Dimensionality =
         GenKinetics.Interfaces.Reactions.Basics.Auto.Dimension.UniUni,
       redeclare final model Inhibition =
         GenKinetics.Interfaces.Reactions.Modifiers.Auto.Inhibitor);

diff --git a/Reactions/LinLog/Auto/ActKinetic.mo b/Reactions/LinLog/Auto/ActKinetic.mo
@@ -3,7 +3,7 @@ model ActKinetic "Implementation of Linlog Kinetic with Activation"
   import GenKinetics;
   extends GenKinetics.Reactions.LinLog.ReactionTerm(redeclare final model
       Modifiers = GenKinetics.Reactions.LinLog.ActivationTerm (redeclare final
-          model       Inhibition =
+          model Inhibition =
             GenKinetics.Interfaces.Reactions.Modifiers.Auto.NoInhibition));
 equation
   v = v_steady + R + A;

diff --git a/Reactions/LinLog/Auto/InhKinetic.mo b/Reactions/LinLog/Auto/InhKinetic.mo
@@ -3,7 +3,7 @@ model InhKinetic "Implementation of Linlog Kinetic with Inhibtion"
   import GenKinetics;
   extends GenKinetics.Reactions.LinLog.ReactionTerm(redeclare final model
       Modifiers = GenKinetics.Reactions.LinLog.InhibitionTerm (redeclare final
-          model       Activation =
+          model Activation =
             GenKinetics.Interfaces.Reactions.Modifiers.Auto.NoActivation));
 equation
   v = v_steady + R + I;

diff --git a/Reactions/package.mo b/Reactions/package.mo
@@ -1,5 +1,5 @@
 within GenKinetics;
-package Reactions
+package Reactions "Reaction components"
   extends Modelica.Icons.VariantsPackage;
 
   annotation (

diff --git a/Substances/package.mo b/Substances/package.mo
@@ -1,5 +1,5 @@
 within GenKinetics;
-package Substances
+package Substances "Substances components"
   extends Modelica.Icons.Package;
 
   annotation (

diff --git a/UnitTests/Internal/DynamicTypes2.mo b/UnitTests/Internal/DynamicTypes2.mo
@@ -1,3 +1,3 @@
 within GenKinetics.UnitTests.Internal;
-package DynamicTypes2 = DynamicTypes (redeclare replaceable class ReactionTypes =
-        GenKinetics.Reactions.Convenience.AutoTypes2);
+package DynamicTypes2 = DynamicTypes (redeclare replaceable class ReactionTypes
+      = GenKinetics.Reactions.Convenience.AutoTypes2);
diff --git a/UnitTests/Internal/DynamicTypes3.mo b/UnitTests/Internal/DynamicTypes3.mo
@@ -1,3 +1,3 @@
 within GenKinetics.UnitTests.Internal;
-package DynamicTypes3 = DynamicTypes (redeclare replaceable class ReactionTypes =
-        GenKinetics.Reactions.Convenience.AutoTypes);
+package DynamicTypes3 = DynamicTypes (redeclare replaceable class ReactionTypes
+      = GenKinetics.Reactions.Convenience.AutoTypes);
diff --git a/UnitTests/package.mo b/UnitTests/package.mo
@@ -1,26 +1,8 @@
 within GenKinetics;
-package UnitTests
+package UnitTests "unit tests"
   extends Modelica.Icons.Package;
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 
 
 

diff --git a/Units/package.mo b/Units/package.mo
@@ -1,5 +1,5 @@
 within GenKinetics;
-package Units
+package Units "all physical units used across the library"
   extends Modelica.Icons.TypesPackage;
 
   type Concentration = Modelica.Icons.TypeReal(final quantity="Concentration",final unit = "mol/l", min = 0)

diff --git a/UserGuide/package.mo b/UserGuide/package.mo
@@ -1,5 +1,5 @@
 within GenKinetics;
-package UserGuide
+package UserGuide "user guide"
   extends Modelica.Icons.Information;
 
   model Overview
@@ -75,7 +75,6 @@ modelica://GenKinetics.Interfaces.Dynamic.Dimension.ReactionDimension\">GenKinet
 </html>"));
   end Contact;
 
-
   model ReleaseNotes
     extends Modelica.Icons.ReleaseNotes;
     annotation (