annotate general/getparam.m @ 7:47cb292350f3
Some documentation fixes.
| author |
samer |
| date |
Mon, 14 Jan 2013 14:52:38 +0000 |
| parents |
e44f49929e56 |
| children |
beb8a3f4a345 |
| rev |
line source |
|
samer@4
|
1 function a=getparam(s,field,def)
|
|
samer@4
|
2 % getparam - get value of named field or default if not present
|
|
samer@4
|
3 %
|
|
samer@7
|
4 % getparam :: struct Fields, string~'field name', A~'default value' -> A.
|
|
samer@4
|
5 %
|
|
samer@4
|
6 % Typical usage is with structures returned by prefs.
|
|
samer@4
|
7
|
|
samer@4
|
8 if isfield(s,field), a=s.(field); else a=def; end
|
|
samer@4
|
9
|
