Mercurial > octave
changeset 23483:6d5a646ede0c
* pt-arg-list.cc: Fix docstring formatting.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Wed, 10 May 2017 13:53:22 -0400 |
| parents | c9937e865768 |
| children | 3ace16b8f062 |
| files | libinterp/parse-tree/pt-arg-list.cc |
| diffstat | 1 files changed, 20 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/parse-tree/pt-arg-list.cc Wed May 10 13:37:43 2017 -0400 +++ b/libinterp/parse-tree/pt-arg-list.cc Wed May 10 13:53:22 2017 -0400 @@ -126,30 +126,29 @@ // END is documented in op-kw-docs. DEFCONSTFUN (end, , , doc: /* -*- texinfo -*- - @deftypefn {} {} end - Last element of an array or the end of any @code{for}, @code{parfor}, - @code{if}, @code{do}, @code{while}, @code{function}, @code{switch}, - @code{try}, or @code{unwind_protect} block. +@deftypefn {} {} end +Last element of an array or the end of any @code{for}, @code{parfor}, +@code{if}, @code{do}, @code{while}, @code{function}, @code{switch}, +@code{try}, or @code{unwind_protect} block. - As an index of an array, the magic index @qcode{"end"} refers to the - last valid entry in an indexing operation. +As an index of an array, the magic index @qcode{"end"} refers to the +last valid entry in an indexing operation. - Example: +Example: - @example - @group - @var{x} = [ 1 2 3 - 4 5 6 ]; - @var{x}(1,end) - @result{} 3 - @var{x}(end,1) - @result{} 4 - @var{x}(end,end) - @result{} 6 - @end group - @end example - @seealso{for, parfor, if, do, while, function, switch, try, unwind_protect} - @end deftypefn */) +@example +@group +@var{x} = [ 1 2 3; 4 5 6 ]; +@var{x}(1,end) + @result{} 3 +@var{x}(end,1) + @result{} 4 +@var{x}(end,end) + @result{} 6 +@end group +@end example +@seealso{for, parfor, if, do, while, function, switch, try, unwind_protect} +@end deftypefn */) { octave_value retval;