Mercurial > octave-nkf
comparison scripts/miscellaneous/getfield.m @ 10821:693e22af08ae
Grammarcheck documentation of m-files
Add newlines between @item fields for readability.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 26 Jul 2010 21:25:36 -0700 |
parents | 9d1a14e12431 |
children | fd0a3ac60b0e |
comparison
equal
deleted
inserted
replaced
10820:c44c786f87ba | 10821:693e22af08ae |
---|---|
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} {[@var{v1}, @dots{}] =} getfield (@var{s}, @var{key}, @dots{}) | 21 ## @deftypefn {Function File} {[@var{v1}, @dots{}] =} getfield (@var{s}, @var{key}, @dots{}) |
22 ## Extract a field from a structure (or a nested structure). For example | 22 ## Extract a field from a structure (or a nested structure). For example: |
23 ## | 23 ## |
24 ## @example | 24 ## @example |
25 ## @group | 25 ## @group |
26 ## ss(1,2).fd(3).b = 5; | 26 ## ss(1,2).fd(3).b = 5; |
27 ## getfield (ss, @{1,2@}, "fd", @{3@}, "b") | 27 ## getfield (ss, @{1,2@}, "fd", @{3@}, "b") |