octave_packages/general-1.3.1/@inputParser/parse.m

   1 ## Copyright (C) 2011 Carnë Draug <carandraug+dev@gmail.com>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {@var{parser} =} parse (@var{parser}, @var{varargin})
  18 ## @deftypefnx {Function File} {@var{parser} =} @var{parser}.parse (@var{varargin})
  19 ## Parses and validates list of arguments according to object @var{parser} of the
  20 ## class inputParser.
  21 ##
  22 ## After parsing, the results can be accessed with the @command{Results}
  23 ## accessor. See @command{help inputParser} for a more complete description.
  24 ##
  25 ## @seealso{inputParser, @@inputParser/addOptional, @@inputParser/addParamValue
  26 ## @@inputParser/addParamValue, @@inputParser/addRequired, @@inputParser/addSwitch}
  27 ## @end deftypefn
  28
  29 function inPar = parse (inPar, varargin)
  30
  31   ## check @inputParser/subsref for the actual code
  32   inPar = subsref (inPar, substruct(
  33                                     '.' , 'parse',
  34                                     '()', varargin
  35                                     ));
  36
  37 endfunction