Mercurial > octave-nkf
diff scripts/ode/private/ode_struct_value_check.m @ 20580:25623ef2ff4f
doc: Rewrite docstrings for ode* family of functions.
* scripts/ode/module.mk: Remove extra newline.
* ode45.m, odeget.m, odeset.m: Rewrite docstrings.
* AbsRel_Norm.m, fuzzy_compare.m, hermite_quartic_interpolation.m,
integrate_adaptive.m, integrate_const.m, integrate_n_steps.m, kahan.m,
ode_struct_value_check.m, odepkg_event_handle.m, odepkg_structure_check.m,
runge_kutta_45_dorpri.m, starting_stepsize.m:
Don't break @deftypefn lines. Wrap lines at 80 columns rather than 72.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 03 Oct 2015 21:03:16 -0700 |
| parents | 6256f6e366ac |
| children | eb9e2d187ed2 |
line wrap: on
line diff
--- a/scripts/ode/private/ode_struct_value_check.m Sat Oct 03 16:21:58 2015 -0400 +++ b/scripts/ode/private/ode_struct_value_check.m Sat Oct 03 21:03:16 2015 -0700 @@ -18,14 +18,13 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{}] =} -## ode_struct_value_check (@var{arg}, [@var{"solver"}]) +## @deftypefn {Function File} {[@var{}] =} ode_struct_value_check (@var{arg}, [@var{"solver"}]) ## ## If this function is called with one input argument of type structure array ## then check the field names and the field values of the OdePkg structure -## @var{arg}. Optionally if this function is called with a second input +## @var{arg}. Optionally if this function is called with a second input ## argument @var{"solver"} of type string that specifies the name of a valid -## OdePkg solver then a higher level error detection is performed. The function +## OdePkg solver then a higher level error detection is performed. The function ## does not modify any of the field names or field values but terminates with ## an error if an invalid option or value is found. ##