Merge pull request #129 from LEMS/feat-add-state-var-doc

docs: add doc for StateVariable
LEMS · Oct 22, 2024 · 4feadcb · 4feadcb
2 parents 069a8d1 + 7b33ca8
commit 4feadcb
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/main/java/org/lemsml/jlems/core/type/dynamics/StateVariable.java b/src/main/java/org/lemsml/jlems/core/type/dynamics/StateVariable.java
@@ -1,5 +1,6 @@
 package org.lemsml.jlems.core.type.dynamics;
 
+import org.lemsml.jlems.core.annotation.ModelElement;
 import org.lemsml.jlems.core.annotation.ModelProperty;
 import org.lemsml.jlems.core.expression.Dimensional;
 import org.lemsml.jlems.core.expression.Valued;
@@ -13,6 +14,7 @@
 
 
 
+@ModelElement(info="Specifies a state variable that stores values that define the state of the system at a point in time. The dynamics of state variables may be defined as Ordinary Differential Equations (ODEs) in TimeDerivatives. StateVariables may be linked to exposures.")
 public class StateVariable implements Valued  {
 
 	@ModelProperty(info="Name of the state variable")