comparison scripts/general/structfun.m @ 10687:a8ce6bdecce5

Improve documentation strings.
author Rik <octave@nomad.inbox5.com>
date Tue, 08 Jun 2010 20:22:38 -0700
parents 95c3e38098bf
children be55736a0783
comparison
equal deleted inserted replaced
10686:8675858ba1e2 10687:a8ce6bdecce5
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} structfun (@var{func}, @var{s}) 21 ## @deftypefn {Function File} {} structfun (@var{func}, @var{s})
22 ## @deftypefnx {Function File} {[@var{a}, @dots{}] =} structfun (@dots{}) 22 ## @deftypefnx {Function File} {[@var{a}, @dots{}] =} structfun (@dots{})
23 ## @deftypefnx {Function File} {} structfun (@dots{}, "ErrorHandler", @var{errfunc}) 23 ## @deftypefnx {Function File} {} structfun (@dots{}, "ErrorHandler", @var{errfunc})
24 ## @deftypefnx {Function File} {} structfun (@dots{}, "UniformOutput", @var{val}) 24 ## @deftypefnx {Function File} {} structfun (@dots{}, "UniformOutput", @var{val})
25 ## 25 ##
26 ## Evaluate the function named @var{name} on the fields of the structure 26 ## Evaluate the function named @var{name} on the fields of the structure
65 ## "identifier", "message" and "index", giving respectively the error 65 ## "identifier", "message" and "index", giving respectively the error
66 ## identifier, the error message, and the index into the input arguments 66 ## identifier, the error message, and the index into the input arguments
67 ## of the element that caused the error. For an example on how to use 67 ## of the element that caused the error. For an example on how to use
68 ## an error handler, @pxref{doc-cellfun, @code{cellfun}}. 68 ## an error handler, @pxref{doc-cellfun, @code{cellfun}}.
69 ## 69 ##
70 ## @seealso{cellfun, arrayfun} 70 ## @seealso{cellfun, arrayfun, spfun}
71 ## @end deftypefn 71 ## @end deftypefn
72 72
73 function varargout = structfun (fun, s, varargin); 73 function varargout = structfun (fun, s, varargin);
74 74
75 if (nargin < 2) 75 if (nargin < 2)