Mercurial > octave-nkf
diff scripts/ode/private/odepkg_structure_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 | fcb792acab9b |
| children | eb9e2d187ed2 |
line wrap: on
line diff
--- a/scripts/ode/private/odepkg_structure_check.m Sat Oct 03 16:21:58 2015 -0400 +++ b/scripts/ode/private/odepkg_structure_check.m Sat Oct 03 21:03:16 2015 -0700 @@ -15,20 +15,33 @@ %# You should have received a copy of the GNU General Public License %# along with this program; If not, see <http://www.gnu.org/licenses/>. -%# -*- texinfo -*- -%# @deftypefn {Function File} {[@var{newstruct}] =} odepkg_structure_check (@var{oldstruct}, [@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{oldstruct} and return the structure as @var{newstruct} if no error is found. Optionally if this function is called with a second input argument @var{"solver"} of type string taht specifies the name of a valid 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. -%# -%# This function is an OdePkg internal helper function therefore it should never be necessary that this function is called directly by a user. There is only little error detection implemented in this function file to achieve the highest performance. -%# -%# Run examples with the command -%# @example -%# demo odepkg_structure_check -%# @end example -%# @end deftypefn -%# -%# @seealso{odepkg} +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{newstruct}] =} odepkg_structure_check (@var{oldstruct}, [@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{oldstruct} and return the structure as @var{newstruct} if no error is +## found. +## +## Optionally if this function is called with a second input argument +## @var{"solver"} of type string taht specifies the name of a valid 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. +## +## This function is an OdePkg internal helper function therefore it should +## never be necessary that this function is called directly by a user. There +## is only little error detection implemented in this function file to +## achieve the highest performance. +## +## Run examples with the command +## +## @example +## demo odepkg_structure_check +## @end example +## @end deftypefn +## +## @seealso{odepkg} function [vret] = odepkg_structure_check (varargin)