Fix broken links

Steven-Roberts · Steven-Roberts · commit beec86c4f629 · 2024-10-05T10:25:23.000-07:00
diff --git a/toolbox/+otp/+ascherlineardae/AscherLinearDAEProblem.m b/toolbox/+otp/+ascherlineardae/AscherLinearDAEProblem.m
@@ -55,7 +55,7 @@
             %    The start and final time.
             % y0 : numeric(2, 1)
             %    The initial condition.
-            % parameters : AscherLinearDAEParameters
+            % parameters : otp.ascherlineardae.AscherLinearDAEParameters
             %    The parameters.
             obj@otp.Problem('Ascher Linear DAE', 2, timeSpan, y0, parameters);
         end
diff --git a/toolbox/+otp/+brusselator/BrusselatorProblem.m b/toolbox/+otp/+brusselator/BrusselatorProblem.m
@@ -50,7 +50,7 @@
             %    The start and final time.
             % y0 : numeric(2, 1)
             %    The initial conditions.
-            % parameters : BrusselatorParameters
+            % parameters : otp.brusselator.BrusselatorParameters
             %    The parameters.
             
             obj@otp.Problem('Brusselator', 2, timeSpan, y0, parameters);
diff --git a/toolbox/+otp/+cusp/CUSPProblem.m b/toolbox/+otp/+cusp/CUSPProblem.m
@@ -86,7 +86,7 @@
             %    The start and final time.
             % y0 : numeric(:, 1)
             %    The initial conditions.
-            % parameters : CUSPParameters
+            % parameters : otp.cusp.CUSPParameters
             %    The parameters.
             
             obj@otp.Problem('CUSP', [], timeSpan, y0, parameters);
diff --git a/toolbox/+otp/+linear/LinearProblem.m b/toolbox/+otp/+linear/LinearProblem.m
@@ -48,7 +48,7 @@
             %    The start and final time.
             % y0 : numeric(:, 1)
             %    The initial conditions.
-            % parameters : LinearParameters
+            % parameters : otp.linear.LinearParameters
             %    The parameters.
             
             obj@otp.Problem('Linear', [], timeSpan, y0, parameters);
diff --git a/toolbox/+otp/+lorenz63/Lorenz63Problem.m b/toolbox/+otp/+lorenz63/Lorenz63Problem.m
@@ -43,7 +43,7 @@
             %    The start and final time.
             % y0 : numeric(3, 1)
             %    The initial conditions.
-            % parameters : Lorenz63Parameters
+            % parameters : otp.lorenz63.Lorenz63Parameters
             %    The parameters.
 
             obj@otp.Problem('Lorenz Equations', 3, timeSpan, y0, parameters);
diff --git a/toolbox/+otp/+lorenz96/Lorenz96Problem.m b/toolbox/+otp/+lorenz96/Lorenz96Problem.m
@@ -44,7 +44,7 @@
             %    The start and final time.
             % y0 : numeric(:, 1)
             %    The initial conditions.
-            % parameters : Lorenz96Parameters
+            % parameters : otp.lorenz96.Lorenz96Parameters
             %    The parameters.
 
             obj@otp.Problem('Lorenz 96', [], timeSpan, y0, parameters);
diff --git a/toolbox/+otp/+oregonator/OregonatorProblem.m b/toolbox/+otp/+oregonator/OregonatorProblem.m
@@ -53,7 +53,7 @@
             %    The start and final time.
             % y0 : numeric(3, 1)
             %    The initial conditions.
-            % parameters : OregonatorParameters
+            % parameters : otp.oregonator.OregonatorParameters
             %    The parameters.
             
             obj@otp.Problem('Oregonator', 3, timeSpan, y0, parameters);
diff --git a/toolbox/+otp/+protherorobinson/ProtheroRobinsonProblem.m b/toolbox/+otp/+protherorobinson/ProtheroRobinsonProblem.m
@@ -35,7 +35,7 @@
             %    The start and final time.
             % y0 : numeric(:, 2)
             %    The initial conditions.
-            % parameters : ProtheroRobinsonParameters
+            % parameters : otp.protherorobinson.ProtheroRobinsonParameters
             %    The parameters.
             
             obj@otp.Problem('Prothero–Robinson', [], timeSpan, y0, parameters);
diff --git a/toolbox/+otp/+robertson/+presets/ROBER.m b/toolbox/+otp/+robertson/+presets/ROBER.m
@@ -1,7 +1,7 @@
 classdef ROBER < otp.robertson.RobertsonProblem
-    % The Robertson configuration from :cite:p:`HW96` (p. 144). This differs from :class:`Canonical` only in the time
-    % span which is extended to $[0, 10^{11}]$. This presents a challenge for numerical integrators to preserve solution
-    % positivity.
+    % The Robertson configuration from :cite:p:`HW96` (p. 144). This differs from
+    % :class:`otp.robertson.presets.Canonical` only in the time span which is extended to $[0, 10^{11}]$. This presents
+    % a challenge for numerical integrators to preserve solution positivity.
 
     methods
         function obj = ROBER
diff --git a/toolbox/+otp/+robertson/RobertsonProblem.m b/toolbox/+otp/+robertson/RobertsonProblem.m
@@ -56,7 +56,7 @@
             %    The start and final time.
             % y0 : numeric(3, 1)
             %    The initial conditions.
-            % parameters : RobertsonParameters
+            % parameters : otp.robertson.RobertsonParameters
             %    The parameters.
             
             obj@otp.Problem('Robertson', 3, timeSpan, y0, parameters);
diff --git a/toolbox/+otp/RHS.m b/toolbox/+otp/RHS.m
@@ -48,8 +48,8 @@
         % t : numeric
         %    The time at which $f$ is evaluated.
         % y : numeric(:, 1) or numeric(:, :)
-        %    The state at which $f$ is evaluated. If :attr:`Vectorized` is ``'on'``, it can be a matrix where each
-        %    column is a state.
+        %    The state at which $f$ is evaluated. If :attr:`otp.RHS.Vectorized` is ``'on'``, it can be a matrix where
+        %    each column is a state.
         %
         % Returns
         % -------
@@ -255,7 +255,8 @@
         %    $\sum_{j,k} \frac{\partial^2 f_i(t, y; p)}{\partial y_j \partial y_k} u_j v_k$.
         HessianVectorProduct
 
-        % The action of a vector on the partial derivative of :attr:`JacobianAdjointVectorProduct` with respect to $y$.
+        % The action of a vector on the partial derivative of :attr:`otp.RHS.JacobianAdjointVectorProduct` with respect
+        % to $y$.
         %
         % If set, it is a function handle with the following signature:
         %
@@ -277,16 +278,18 @@
     end
     
     properties (Dependent)
-        % A dependent property which returns :attr:`Jacobian` if it is a matrix and ``[]`` if it is a function handle.
+        % A dependent property which returns :attr:`otp.RHS.Jacobian` if it is a matrix and ``[]`` if it is a function
+        % handle.
         JacobianMatrix
 
-        % A dependent property which wraps :attr:`Jacobian` in a function handle if necessary.
+        % A dependent property which wraps :attr:`otp.RHS.Jacobian` in a function handle if necessary.
         JacobianFunction
 
-        % A dependent property which returns :attr:`Mass` if it is a matrix and ``[]`` if it is a function handle.
+        % A dependent property which returns :attr:`otp.RHS.Mass` if it is a matrix and ``[]`` if it is a function
+        % handle.
         MassMatrix
 
-        % A dependent property which wraps :attr:`Mass` in a function handle if necessary.
+        % A dependent property which wraps :attr:`otp.RHS.Mass` in a function handle if necessary.
         MassFunction
     end
 
@@ -304,8 +307,8 @@
             %
             % Warning
             % -------
-            % In Octave, the value for :attr:`Vectorized` is ignored because it is not used by built in solvers and
-            % causes an error for ``ode15s``.
+            % In Octave, the value for :attr:`otp.RHS.Vectorized` is ignored because it is not used by built in solvers
+            % and causes an error for ``ode15s``.
 
             obj.F = F;
             if mod(nargin, 2) == 0
