Mercurial > hg > octave-lyh
diff scripts/miscellaneous/getfield.m @ 15615:808e4f13e220
doc: Update struct documentation to match new indexing rules
* container.txi: Mention that fields can now be arbitrary strings and
issues that this may cause with Matlab.
* setfield.m: Completely rewrite docstring. More examples.
* getfield.m: Remove most of the docstring and refer to setfield's
docstring instead.
author | Jordi Gutiérrez Hermoso <jordigh@octave.org> |
---|---|
date | Tue, 20 Nov 2012 16:17:01 -0500 |
parents | f3d52523cde1 |
children | 12005245b645 |
line wrap: on
line diff
--- a/scripts/miscellaneous/getfield.m +++ b/scripts/miscellaneous/getfield.m @@ -18,28 +18,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {[@var{v1}, @dots{}] =} getfield (@var{s}, @var{key}, @dots{}) -## Extract a field from a structure (or a nested structure). For example: -## -## @example -## @group -## ss(1,2).fd(3).b = 5; -## getfield (ss, @{1,2@}, "fd", @{3@}, "b") -## @result{} 5 -## @end group -## @end example +## @deftypefn {Function File} {[@var{val}] =} getfield (@var{s}, @var{field}) +## @deftypefnx {Function File} {[@var{val}] =} getfield (@var{s}, @var{idx1}, @var{field1}, @var{idx2}, @var{field2}, @dots{}) +## Extract a field from a structure (or a nested structure). The syntax +## is the same as @code{setfield}, except it omits the final @var{val} +## argument, returning this value instead of setting it. ## -## Note that the function call in the previous example is equivalent to -## the expression -## -## @example -## @group -## i1 = @{1,2@}; i2 = "fd"; i3 = @{3@}; i4= "b"; -## ss(i1@{:@}).(i2)(i3@{:@}).(i4) -## @result{} 5 -## -## @end group -## @end example ## @seealso{setfield, rmfield, isfield, isstruct, fieldnames, struct} ## @end deftypefn