Mercurial > octave-nkf
comparison libinterp/octave-value/ov-bool-mat.cc @ 18533:ea0d4dea1a17 stable
doc: Update documentation for functions in octave-value dir.
* ov-bool-mat.cc (Flogical): Document that input must be numeric.
Document incompatibility with Matlab regarding complex inputs.
* ov-cell.cc (Fcell): Add seealso references.
* ov-cell.cc (Fcellstr): Document that trailing spaces are trimmed.
Add seealso references.
* ov-cell.cc (Fstruct2cell): Use lowercase names in @var references.
* ov-class.cc (Fismethod): Add seealso reference to isprop.
* ov-class.cc (Fsuperiorto): Add seealso reference to inferiorto.
* ov-class.cc (Finferiorto): Add seealso reference to superiorto.
* ov-fcn-handle.cc (Ffunctions): Add table to documentation describing return
values.
* ov-fcn-handle.cc (Ffunc2str): Add seealso links to str2func, functions.
* ov-fcn-handle.cc (Fstr2func): Add seealso links to func2str, inline.
* ov-fcn-handle.cc (Fis_function_handle): Add seealso links to functions.
* ov-fcn-inline.cc (Finline): Add note that the use of inline is discouraged.
Add seealso link to str2func.
* ov-int16.cc (Fint16): Add seealso links to docstring.
* ov-int32.cc (Fint32): Add seealso links to docstring.
* ov-int64.cc (Fint64): Add seealso links to docstring.
* ov-int8.cc (Fint8): Add seealso links to docstring.
* ov-oncleanup.cc (FonCleanup): clarify docstring by using "function" rather
than "action" for what gets called when onCleanup object is destroyed.
* ov-struct.cc (Fstruct): Add additional calling forms. Add seealso links.
* ov-struct.cc (Fisfield): Add additional calling forms. Add seealso link.
* ov-struct.cc (Fnfields): Add seealso link.
* ov-struct.cc (Fcell2struct): Add additional calling forms. Add seealso link.
* ov-struct.cc (Frmfield): Emphasize that a copy of the struct is returned.
Add seealso link.
* ov-struct.cc (Fstruct_levels_to_print): Add seealso link to
print_struct_array_contents.
* ov-struct.cc (Fprint_struct_array_contents): Add seealso link to
struct_levels_to_print.
* ov-typeinfo.cc (Ftypeinfo): Add seealso links to class, isa.
* ov-uint16.cc (Fuint16): Add seealso links to docstring.
* ov-uint32.cc (Fuint32): Add seealso links to docstring.
* ov-uint64.cc (Fuint64): Add seealso links to docstring.
* ov-uint8.cc (Fuint8): Add seealso links to docstring.
* ov-usr-fcn.cc (Fnargin): Add example based on 'union' function.
* ov-usr-fcn.cc (Fnargout): Add example based on 'imread' function.
* ov-usr-fcn.cc (Foptimize_subsasgn_calls): Improve docstring.
* ov.cc (Fsubsref): Rephrase one sentence.
* fieldnames.m: Add more functions to seealso links.
* getfield.m: Re-order seealso links.
* setfield.m: Re-order seealso links.
* isprop.m Add ismethod, isobject to seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 01 Mar 2014 21:50:13 -0800 |
parents | 175b392e91fe |
children | f958e8cd6348 |
comparison
equal
deleted
inserted
replaced
18532:87dfe4892ef9 | 18533:ea0d4dea1a17 |
---|---|
547 } | 547 } |
548 | 548 |
549 DEFUN (logical, args, , | 549 DEFUN (logical, args, , |
550 "-*- texinfo -*-\n\ | 550 "-*- texinfo -*-\n\ |
551 @deftypefn {Built-in Function} {} logical (@var{x})\n\ | 551 @deftypefn {Built-in Function} {} logical (@var{x})\n\ |
552 Convert @var{x} to logical type.\n\ | 552 Convert the numeric object @var{x} to logical type.\n\ |
553 \n\ | |
554 Any non-zero values will be converted to true (1) while zero values\n\ | |
555 will be converted to false (0). The non-numeric value NaN cannot be\n\ | |
556 converted and will produce an error.\n\ | |
557 \n\ | |
558 Compatibility Note: Octave accepts complex values as input, whereas\n\ | |
559 @sc{matlab} issues an error.\n\ | |
553 @seealso{double, single, char}\n\ | 560 @seealso{double, single, char}\n\ |
554 @end deftypefn") | 561 @end deftypefn") |
555 { | 562 { |
556 octave_value retval; | 563 octave_value retval; |
557 | 564 |