octave: libinterp/op-kw-docs annotate

annotate libinterp/op-kw-docs @ 33608:5fba13104493 bytecode-interpreter tip

maint: merge default to bytecode-interpreter.

author	Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date	Sat, 18 May 2024 22:40:00 -0400
parents	476a7ecc1f4c
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 32053 diff changeset	3 ## Copyright (C) 1993-2024 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26778 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	7 ##
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	8 ## This file is part of Octave.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24510 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24510 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22431 diff changeset	13 ## (at your option) any later version.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	14 ##
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22431 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22431 diff changeset	18 ## GNU General Public License for more details.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	19 ##
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 24510 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	25
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	26 !
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	27 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	28 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	29 @deftypefn {} {} !
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	30 Logical 'not' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	31 @seealso{~, not}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	32 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	33 ~
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	34 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	35 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	36 @deftypefn {} {} ~
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	37 Logical 'not' operator.
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	38
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	39 The symbol may also be used to discard outputs of a function that are unwanted
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	40 without using a temporary variable.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	41
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	42 @example
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	43 [~, @var{idx_of_max}] = max (@var{x})
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	44 @end example
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	45 @seealso{!, not}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	46 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	47 !=
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	48 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	49 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	50 @deftypefn {} {} !=
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	51 Logical 'not equals' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	52 @seealso{~=, ne}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	53 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	54 ~=
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	55 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	56 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	57 @deftypefn {} {} ~=
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	58 Logical 'not equals' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	59 @seealso{!=, ne}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	60 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	61 "
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	62 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	63 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	64 @deftypefn {} {} "
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	65 String delimiter.
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	66
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	67 Escape sequences within double-quoted strings are expanded. I.e., "\n" is a
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	68 1-character string representing a newline. See the single quote delimiter (')
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	69 to create strings without escape sequence processing.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	70 @seealso{'}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	71 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	72 #
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	73 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	74 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	75 @deftypefn {} {} #
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	76 Begin comment character.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	77 @seealso{%, #@\{}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	78 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	79 %
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	80 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	81 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	82 @deftypefn {} {} %
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	83 Begin comment character.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	84 @seealso{#, %@\{}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	85 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	86 #{
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	87 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	88 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	89 @deftypefn {} {} #@{
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	90 Begin block comment.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	91
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	92 The sequence @code{#@{} must appear alone on a line with no other characters,
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	93 other than whitespace, before or after it. It is possible to nest block
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	94 comments.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	95 @seealso{%@\{, #@\}, #}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	96 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	97 %{
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	98 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	99 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	100 @deftypefn {} {} %@{
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	101 Begin block comment.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	102
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	103 The sequence @code{%@{} must appear alone on a line with no other characters,
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	104 other than whitespace, before or after it. It is possible to nest block
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	105 comments.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	106 @seealso{#@\{, %@\}, %}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	107 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	108 #}
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	109 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	110 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	111 @deftypefn {} {} #@}
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	112 Close block comment.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	113
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	114 The sequence @code{#@}} must appear alone on a line with no other characters,
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	115 other than whitespace, before or after it. It is possible to nest block
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	116 comments.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	117 @seealso{%@\}, #@\{, #}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	118 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	119 %}
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	120 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	121 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	122 @deftypefn {} {} %@}
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	123 Close block comment.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	124
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	125 The sequence @code{%@}} must appear alone on a line with no other characters,
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	126 other than whitespace, before or after it. It is possible to nest block
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	127 comments.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	128 @seealso{#@\}, %@\{, %}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	129 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	130 ...
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	131 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	132 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	133 @deftypefn {} {} ...
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	134 Continuation marker.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	135
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	136 Joins current line with following line before parsing. This can be used to
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	137 improve the human-readability of Octave code, without affecting interpretation.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	138 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	139 &
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	140 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	141 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	142 @deftypefn {} {} &
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	143 Element-by-element logical 'and' operator.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	144 @seealso{and, &&}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	145 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	146 &&
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	147 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	148 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	149 @deftypefn {} {} &&
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	150 Logical 'and' operator (with short-circuit evaluation).
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	151 @seealso{&}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	152 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	153 '
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	154 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	155 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	156 @deftypefn {} {} '
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	157 Matrix transpose operator or string delimiter.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	158
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	159 For complex matrices, computes the complex conjugate (Hermitian) transpose.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	160
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	161 The single quote character may also be used to delimit strings. Escape
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	162 sequences within single-quoted strings are not expanded. I.e., '\n' is a
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	163 2-character string '\' and 'n' rather than "\n" which is a single character
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	164 representing a newline.
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	165 @seealso{ctranspose, .', "}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	166 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	167 (
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	168 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	169 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	170 @deftypefn {} {} (
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	171 Array index or function argument delimiter.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	172 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	173 )
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	174 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	175 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	176 @deftypefn {} {})
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	177 Array index or function argument delimiter.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	178 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	179 *
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	180 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	181 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	182 @deftypefn {} {} *
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	183 Multiplication operator.
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	184 @seealso{mtimes, .*}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	185 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	186 **
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	187 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	188 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	189 @deftypefn {} {} **
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	190 Power operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	191
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	192 This may return complex results for real inputs. Use @code{realsqrt},
25642 cf452aa01cd5 doc: Replace instances of realroot (non-existent) with realpow (bug #54336). Rik <rik@octave.org> parents: 25280 diff changeset	193 @code{cbrt}, @code{nthroot}, or @code{realpow} to obtain real results when
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	194 possible.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	195 @seealso{power, ^, .**, .^, realpow, realsqrt, cbrt, nthroot}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	196 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	197 ^
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	198 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	199 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	200 @deftypefn {} {} ^
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	201 Power operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	202
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	203 This may return complex results for real inputs. Use @code{realsqrt},
25642 cf452aa01cd5 doc: Replace instances of realroot (non-existent) with realpow (bug #54336). Rik <rik@octave.org> parents: 25280 diff changeset	204 @code{cbrt}, @code{nthroot}, or @code{realpow} to obtain real results when
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	205 possible.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	206 @seealso{power, , .^, ., realpow, realsqrt, cbrt, nthroot}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	207 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	208 +
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	209 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	210 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	211 @deftypefn {} {} +
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	212 Addition operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	213 @seealso{plus}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	214 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	215 ++
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	216 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	217 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	218 @deftypefn {} {} ++
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	219 Increment operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	220
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	221 Add 1 to existing value of variable. As in C, may be applied as a prefix
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	222 (@code{++x}) or postfix (@code{x++}) operator.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	223 @seealso{--}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	224 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	225 ,
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	226 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	227 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	228 @deftypefn {} {} ,
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	229 Array index, function argument, or command separator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	230 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	231 -
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	232 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	233 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	234 @deftypefn {} {} -
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	235 Subtraction or unary negation operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	236 @seealso{minus}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	237 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	238 --
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	239 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	240 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	241 @deftypefn {} {} --
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	242 Decrement operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	243
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	244 Subtract 1 from existing value of variable. As in C, may be applied as a
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	245 prefix (@code{--x}) or postfix (@code{x--}) operator.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	246 @seealso{++}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	247 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	248 .'
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	249 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	250 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	251 @deftypefn {} {} .'
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	252 Matrix transpose operator.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	253
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	254 For complex matrices, computes the transpose, @emph{not} the complex conjugate
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	255 (Hermitian) transpose.
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	256 @seealso{transpose, '}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	257 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	258 .*
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	259 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	260 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	261 @deftypefn {} {} .*
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	262 Element-by-element multiplication operator.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	263 @seealso{times, *}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	264 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	265 .**
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	266 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	267 -- texinfo --
22431 475b4cd1b789 doc: Correct docstring for '.*' operator (bug #48973) Rik <rik@octave.org>* parents: 22430 diff changeset	268 @deftypefn {} {} .**
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	269 Element-by-element power operator.
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	270
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	271 If several complex results are possible, returns the one with smallest
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	272 non-negative argument (angle). Use @code{realpow}, @code{realsqrt},
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	273 @code{cbrt}, or @code{nthroot} if a real result is preferred.
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	274 @seealso{power, .^, **, ^, realpow, realsqrt, cbrt, nthroot}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	275 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	276 .^
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	277 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	278 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	279 @deftypefn {} {} .^
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	280 Element-by-element power operator.
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	281
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	282 If several complex results are possible, returns the one with smallest
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	283 non-negative argument (angle). Use @code{realpow}, @code{realsqrt},
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	284 @code{cbrt}, or @code{nthroot} if a real result is preferred.
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	285 @seealso{power, ., ^, , realpow, realsqrt, cbrt, nthroot}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	286 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	287 ./
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	288 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	289 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	290 @deftypefn {} {} ./
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	291 Element-by-element right division operator.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	292 @seealso{rdivide, /, mrdivide, .\\}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	293 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	294 /
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	295 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	296 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	297 @deftypefn {} {} /
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	298 Right division operator.
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	299 @seealso{mrdivide, ./, rdivide, \\}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	300 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	301 .\
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	302 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	303 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	304 @deftypefn {} {} .\
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	305 Element-by-element left division operator.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	306 @seealso{ldivide, \\, mldivide, ./}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	307 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	308 \
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	309 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	310 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	311 @deftypefn {} {} \
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	312 Left division operator.
24509 d8ed90ecd4fd doc: Add documentation for '\' string continuation marker (bug #52774). Rik <rik@octave.org> parents: 24414 diff changeset	313
d8ed90ecd4fd doc: Add documentation for '\' string continuation marker (bug #52774). Rik <rik@octave.org> parents: 24414 diff changeset	314 Within double-quoted strings, @samp{\} is the line continuation marker used
d8ed90ecd4fd doc: Add documentation for '\' string continuation marker (bug #52774). Rik <rik@octave.org> parents: 24414 diff changeset	315 to join the current line with the following line.
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	316 @seealso{mldivide, .\\, ldivide, /}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	317 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	318 :
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	319 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	320 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	321 @deftypefn {} {} :
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	322 Select all elements in the specified dimension when indexing.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	323
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	324 @example
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	325 x(2, :) # selects 2nd row, all columns
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	326 @end example
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	327 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	328 ;
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	329 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	330 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	331 @deftypefn {} {} ;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	332 Array row or command separator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	333 @seealso{,}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	334 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	335 <
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	336 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	337 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	338 @deftypefn {} {} <
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	339 'Less than' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	340 @seealso{lt}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	341 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	342 <=
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	343 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	344 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	345 @deftypefn {} {} <=
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	346 'Less than' or 'equals' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	347 @seealso{le}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	348 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	349 =
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	350 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	351 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	352 @deftypefn {} {} =
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	353 Assignment operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	354 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	355 ==
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	356 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	357 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	358 @deftypefn {} {} ==
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	359 Equality test operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	360 @seealso{eq}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	361 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	362 >
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	363 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	364 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	365 @deftypefn {} {} >
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	366 'Greater than' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	367 @seealso{gt}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	368 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	369 >=
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	370 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	371 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	372 @deftypefn {} {} >=
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	373 'Greater than' or 'equals' operator.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	374 @seealso{ge}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	375 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	376 [
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	377 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	378 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	379 @deftypefn {} {} [
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	380 Return list delimiter.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	381 @seealso{]}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	382 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	383 ]
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	384 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	385 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	386 @deftypefn {} {} ]
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	387 Return list delimiter.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	388 @seealso{[}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	389 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	390 \|
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	391 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	392 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	393 @deftypefn {} {} \|
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	394 Element-by-element logical 'or' operator.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	395 @seealso{or, \|\|}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	396 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	397 \|\|
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	398 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	399 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	400 @deftypefn {} {} \|\|
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	401 Logical 'or' (with short-circuit evaluation) operator.
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	402 @seealso{\|}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	403 @end deftypefn
24510 a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	404 @
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	405 @c libinterp/parse-tree/oct-parse.yy
24510 a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	406 -- texinfo --
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	407 @deftypefn {} {} @@
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	408 Return handle to a function.
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	409
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	410 Example:
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	411
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	412 @example
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	413 @group
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	414 f = @@plus;
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	415 f (2, 2)
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	416 @result{} 4
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	417 @end group
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	418 @end example
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	419
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	420 (Note: @@ also finds use in creating classes. See the manual chapter titled
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	421 Object Oriented Programming for a detailed description.)
24510 a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	422 @seealso{function, functions, func2str, str2func}
a2569d574ae5 Add a help entry and documentation for @ character (bug #52771). Daniel J Sebald <daniel.sebald@ieee.org> parents: 24509 diff changeset	423 @end deftypefn
32962 476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	424 __FILE__
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	425 @c libinterp/parse-tree/lex.ll
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	426 -- texinfo --
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	427 @deftypefn {} {} __FILE__
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	428 When the lexer recognizes the @qcode{"__FILE__"} keyword it returns a
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	429 character array containing the full name and path of the file that is being
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	430 executed. @qcode{"__FILE__"} will return @code{stdin} if called from the
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	431 command line.
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	432 @seealso{__LINE__}
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	433 @end deftypefn
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	434 __LINE__
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	435 @c libinterp/parse-tree/lex.ll
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	436 -- texinfo --
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	437 @deftypefn {} {} __LINE__
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	438 When the lexer recognizes the @qcode{"__LINE__"} keyword it returns a numeric
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	439 value containing the current input line number of the function or file being
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	440 executed. @qcode{"__LINE__"} will return @code{1} if called from the command
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	441 line.
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	442 @seealso{__FILE__}
476a7ecc1f4c doc: Add keyword docstrings for __FILE__ and __LINE__. (bug #59737) Nicholas R. Jankowski <jankowski.nicholas@gmail.com> parents: 32793 diff changeset	443 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	444 break
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	445 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	446 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	447 @deftypefn {} {} break
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	448 Exit the innermost enclosing do, while, or for loop.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	449 @seealso{do, while, for, parfor, continue}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	450 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	451 case
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	452 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	453 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	454 @deftypefn {} {} case @var{value}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	455 @deftypefnx {} {} case @{@var{value}, @dots{}@}
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	456 A case statement in a switch block.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	457
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	458 Octave cases are exclusive and do not fall-through as do C-language cases. A
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	459 switch statement must have at least one case. See @code{switch} for an
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	460 example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	461 @seealso{switch}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	462 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	463 catch
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	464 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	465 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	466 @deftypefn {} {} catch
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	467 @deftypefnx {} {} catch @var{value}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	468 Begin the cleanup part of a try-catch block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	469 @seealso{try}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	470 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	471 classdef
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	472 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	473 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	474 @deftypefn {} {} classdef
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	475 Begin a classdef block.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	476 @seealso{properties, methods, events, enumeration}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	477 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	478 continue
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	479 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	480 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	481 @deftypefn {} {} continue
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	482 Jump to the end of the innermost enclosing do, while, or for loop.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	483 @seealso{break, do, while, for, parfor}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	484 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	485 do
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	486 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	487 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	488 @deftypefn {} {} do
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	489 Begin a do-until loop.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	490
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	491 This differs from a while loop in that the body of the loop is executed at
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	492 least once.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	493
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	494 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	495 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	496 i = 0;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	497 do
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	498 i++
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	499 until (i == 10)
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	500 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	501 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	502 @seealso{for, until, while}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	503 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	504 else
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	505 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	506 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	507 @deftypefn {} {} else
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	508 Alternate action for an if block.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	509
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	510 See @code{if} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	511 @seealso{if}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	512 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	513 elseif
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	514 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	515 -- texinfo --
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	516 @deftypefn {} {} elseif (@var{cond})
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	517 Alternate conditional test for an if block.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	518
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	519 The conditional @var{cond} is true if it is not empty and if @emph{all} values
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	520 are nonzero.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	521
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	522 See @code{if} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	523 @seealso{if}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	524 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	525 end_try_catch
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	526 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	527 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	528 @deftypefn {} {} end_try_catch
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	529 Mark the end of a @code{try-catch} block.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	530 @seealso{try, catch}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	531 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	532 end_unwind_protect
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	533 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	534 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	535 @deftypefn {} {} end_unwind_protect
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	536 Mark the end of an unwind_protect block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	537 @seealso{unwind_protect}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	538 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	539 endclassdef
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	540 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	541 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	542 @deftypefn {} {} endclassdef
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	543 Mark the end of a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	544 @seealso{classdef}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	545 @end deftypefn
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	546 endenumeration
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	547 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	548 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	549 @deftypefn {} {} endenumeration
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	550 Mark the end of an enumeration block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	551 @seealso{enumeration}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	552 @end deftypefn
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	553 endevents
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	554 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	555 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	556 @deftypefn {} {} endevents
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	557 Mark the end of an events block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	558 @seealso{events}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	559 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	560 endfor
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	561 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	562 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	563 @deftypefn {} {} endfor
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	564 Mark the end of a for loop.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	565
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	566 See @code{for} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	567 @seealso{for}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	568 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	569 endfunction
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	570 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	571 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	572 @deftypefn {} {} endfunction
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	573 Mark the end of a function.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	574 @seealso{function}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	575 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	576 endif
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	577 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	578 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	579 @deftypefn {} {} endif
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	580 Mark the end of an if block.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	581
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	582 See @code{if} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	583 @seealso{if}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	584 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	585 endmethods
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	586 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	587 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	588 @deftypefn {} {} endmethods
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	589 Mark the end of a methods block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	590 @seealso{methods}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	591 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	592 endparfor
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	593 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	594 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	595 @deftypefn {} {} endparfor
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	596 Mark the end of a parfor loop.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	597
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	598 See @code{parfor} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	599 @seealso{parfor}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	600 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	601 endproperties
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	602 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	603 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	604 @deftypefn {} {} endproperties
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	605 Mark the end of a properties block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	606 @seealso{properties}
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	607 @end deftypefn
28517 6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	608 endspmd
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	609 @c libinterp/parse-tree/oct-parse.yy
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	610 -- texinfo --
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	611 @deftypefn {} {} endparfor
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	612 Mark the end of an spmd block. See @code{spmd} for an example.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	613 @seealso{spmd, parfor}
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	614 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	615 endswitch
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	616 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	617 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	618 @deftypefn {} {} endswitch
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	619 Mark the end of a switch block.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	620
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	621 See @code{switch} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	622 @seealso{switch}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	623 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	624 endwhile
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	625 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	626 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	627 @deftypefn {} {} endwhile
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	628 Mark the end of a while loop.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	629
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	630 See @code{while} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	631 @seealso{do, while}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	632 @end deftypefn
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	633 enumeration
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	634 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	635 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	636 @deftypefn {} {} enumeration
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	637 Begin an enumeration block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	638 @end deftypefn
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	639 events
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	640 @c libinterp/parse-tree/oct-parse.yy
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	641 -- texinfo --
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	642 @deftypefn {} {} events
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	643 Begin an events block in a classdef definition.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	644 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	645 for
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	646 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	647 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	648 @deftypefn {} {} for @var{i} = @var{range}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	649 Begin a for loop.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	650
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	651 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	652 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	653 for i = 1:10
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	654 i
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	655 endfor
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	656 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	657 @end example
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	658 @seealso{parfor, do, while}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	659 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	660 function
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	661 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	662 -- texinfo --
25087 8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	663 @deftypefn {} {} function @var{outputs} = function_name (@var{input}, @dots{})
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	664 @deftypefnx {} {} function {} function_name (@var{input}, @dots{})
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	665 @deftypefnx {} {} function @var{outputs} = function_name
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	666 Begin a function body with name @code{function_name}, with @var{outputs} as
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	667 results, and with @var{inputs} as parameters.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	668
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	669 The function can later be invoked in Octave using the syntax
25087 8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	670
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	671 @example
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	672 [@var{output1}, @var{output2}, @dots{}] = function_name (@var{input1}, @var{input2}, @dots{})
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	673 @end example
8f1ab6db6709 doc: Improve docstring for function keyword (bug #53146) Rik <rik@octave.org> parents: 25054 diff changeset	674
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	675 @seealso{return}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	676 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	677 global
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	678 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	679 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	680 @deftypefn {} {} global @var{var}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	681 Declare variables to have global scope.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	682
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	683 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	684 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	685 global @var{x};
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	686 if (isempty (@var{x}))
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	687 x = 1;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	688 endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	689 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	690 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	691 @seealso{persistent}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	692 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	693 if
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	694 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	695 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	696 @deftypefn {} {} if (@var{cond}) @dots{} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	697 @deftypefnx {} {} if (@var{cond}) @dots{} else @dots{} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	698 @deftypefnx {} {} if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	699 @deftypefnx {} {} if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	700 Begin an if block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	701
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	702 The conditional @var{cond} is true if it is not empty and if @emph{all} values
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	703 are nonzero.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	704
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	705 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	706 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	707 x = 1;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	708 if (x == 1)
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	709 disp ("one");
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	710 elseif (x == 2)
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	711 disp ("two");
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	712 else
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	713 disp ("not one or two");
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	714 endif
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	715 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	716 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	717 @seealso{switch}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	718 @end deftypefn
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	719 @c ## FIXME: Can't have duplicate DOCSTRING entries. The function methods()
25280 1eff55e9debe doc: Stop cruft from being printed after "help if". Rik <rik@octave.org> parents: 25087 diff changeset	720 @c ## already has a docstring which overrides this keyword definition.
32053 88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	721 @c ## If this is fixed, place \x1d char before keyword "methods".
88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	722 @c ## methods
88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	723 @c ## @c libinterp/parse-tree/oct-parse.yy
88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	724 @c ## -- texinfo --
88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	725 @c ## @deftypefn {} {} methods
88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	726 @c ## Begin a methods block in a classdef definition.
88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	727 @c ## @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	728 otherwise
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	729 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	730 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	731 @deftypefn {} {} otherwise
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	732 The default statement in a switch block which is executed when no other
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	733 case statements match the input.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	734 @seealso{switch, case}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	735 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	736 parfor
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	737 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	738 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	739 @deftypefn {} {} parfor @var{i} = @var{range}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	740 @deftypefnx {} {} parfor (@var{i} = @var{range}, @var{maxproc})
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	741 Begin a for loop that may execute in parallel.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	742
26588 21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	743 A @code{parfor} loop has the same syntax as a @code{for} loop. If your Octave
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	744 session has a parallel processing pool enabled, the iterations of the
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	745 @code{parfor} loop will be executed in parallel across the pool's workers.
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	746 Otherwise, @code{parfor} will behave exactly as @code{for}.
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	747
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	748 When operating in parallel mode, a @code{parfor} loop's iterations are not
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	749 guaranteed to occur sequentially, and there are additional restrictions about
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	750 the data access operations you can do inside the loop body.
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	751
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	752 @strong{Warning:} parallel processing pools are currently unimplemented in
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	753 Octave; @code{parfor} currently behaves exactly as a normal @code{for} loop.
21708bdc1c07 doc: Clarify that parfor is not implemented. Andrew Janke <andrew@apjanke.net> parents: 26515 diff changeset	754
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	755 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	756 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	757 parfor i = 1:10
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	758 i
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	759 endparfor
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	760 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	761 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	762 @seealso{for, do, while}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	763 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	764 persistent
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	765 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	766 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	767 @deftypefn {} {} persistent @var{var}
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	768 Declare variables as persistent.
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	769
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	770 A variable that has been declared persistent within a function will retain its
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	771 contents in memory between subsequent calls to the same function. The
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	772 difference between persistent variables and global variables is that persistent
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	773 variables are local in scope to a particular function and are not visible
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	774 elsewhere.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	775 @seealso{global}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	776 @end deftypefn
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	777 @c ## FIXME: Can't have duplicate DOCSTRING entries. The function properties()
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	778 @c ## already has a docstring which overrides this keyword definition.
32053 88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	779 @c ## If this is fixed, place \x1d char before keyword "properties".
88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	780 @c ## properties
88e7edd94e2e Return documentation for "help properties" (bug #64067) Rik <rik@octave.org> parents: 31706 diff changeset	781 @c ## @c libinterp/parse-tree/oct-parse.yy
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	782 @c ## -- texinfo --
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	783 @c ## @deftypefn {} {} properties
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	784 @c ## Begin a properties block in a classdef definition.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	785 @c ## @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	786 return
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	787 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	788 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	789 @deftypefn {} {} return
30686 bca7aebe3e2d doc: Clarify documentation for "return" keyword (bug #61918). Rik <rik@octave.org> parents: 30564 diff changeset	790 Return execution control immediately from a function or script to the calling
bca7aebe3e2d doc: Clarify documentation for "return" keyword (bug #61918). Rik <rik@octave.org> parents: 30564 diff changeset	791 code.
bca7aebe3e2d doc: Clarify documentation for "return" keyword (bug #61918). Rik <rik@octave.org> parents: 30564 diff changeset	792
bca7aebe3e2d doc: Clarify documentation for "return" keyword (bug #61918). Rik <rik@octave.org> parents: 30564 diff changeset	793 @code{return} is used to stop executing code and exit an m-file immediately
bca7aebe3e2d doc: Clarify documentation for "return" keyword (bug #61918). Rik <rik@octave.org> parents: 30564 diff changeset	794 rather than continuing until the end of the function or script is reached.
bca7aebe3e2d doc: Clarify documentation for "return" keyword (bug #61918). Rik <rik@octave.org> parents: 30564 diff changeset	795
bca7aebe3e2d doc: Clarify documentation for "return" keyword (bug #61918). Rik <rik@octave.org> parents: 30564 diff changeset	796 If the function or script was invoked directly, rather than from calling code
bca7aebe3e2d doc: Clarify documentation for "return" keyword (bug #61918). Rik <rik@octave.org> parents: 30564 diff changeset	797 in an m-file, then Octave returns to the command line.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	798 @seealso{function}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	799 @end deftypefn
28517 6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	800 spmd
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	801 @c libinterp/parse-tree/oct-parse.yy
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	802 -- texinfo --
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	803 @deftypefn {} {} spmd
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	804 @deftypefnx {} {} spmd (@var{n})
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	805 @deftypefnx {} {} spmd (@var{m}, @var{n})
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	806 Begin a block of statements which may execute in parallel across multiple
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	807 workers.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	808
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	809 If Octave has a parallel processing pool enabled, the block of code will be
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	810 executed in parallel across all of the pool's workers. Otherwise, @code{spmd}
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	811 has no effect and the statements are processed as normal code by the main
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	812 Octave interpreter.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	813
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	814 If called with one additional argument @var{n} then use exactly @var{n} workers
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	815 from the pool. If called with two arguments @var{m}, @var{n} then use a
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	816 minimum of @var{m} workers and a maximum of @var{n} workers from the parallel
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	817 pool.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	818
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	819 @strong{Warning:} parallel processing pools are currently unimplemented in
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	820 Octave; @code{spmd} currently does nothing, but is included to avoid breaking
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	821 existing @sc{matlab} code.
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	822
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	823 @seealso{parfor}
6e8a9845d118 Add 'spmd' as interpreter keyword for Matlab compatibility (bug #58676). Rik <rik@octave.org> parents: 27923 diff changeset	824 @end deftypefn
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	825 switch
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	826 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	827 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	828 @deftypefn {} {} switch @var{statement}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	829 Begin a switch block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	830
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	831 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	832 @group
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	833 yesno = "yes";
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	834
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	835 switch (yesno)
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	836 case @{"Yes" "yes" "YES" "y" "Y"@}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	837 value = 1;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	838 case @{"No" "no" "NO" "n" "N"@}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	839 value = 0;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	840 otherwise
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	841 error ("invalid value");
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	842 endswitch
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	843 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	844 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	845 @seealso{if, case, otherwise}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	846 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	847 try
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	848 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	849 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	850 @deftypefn {} {} try
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	851 Begin a try-catch block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	852
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	853 If an error occurs within a try block, then the catch code will be run and
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	854 execution will proceed after the catch block (though it is often recommended to
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	855 use the @code{lasterr} function to re-throw the error after cleanup is
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	856 completed).
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	857 @seealso{catch, unwind_protect}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	858 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	859 until
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	860 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	861 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	862 @deftypefn {} {} until (@var{cond})
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	863 End a do-until loop.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	864
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	865 The conditional @var{cond} is true if it is not empty and if @emph{all} values
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	866 are nonzero.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	867
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	868 See @code{do} for an example.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	869 @seealso{do}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	870 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	871 unwind_protect
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	872 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	873 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	874 @deftypefn {} {} unwind_protect
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	875 Begin an unwind_protect block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	876
24413 50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	877 If an error occurs within the first part of an unwind_protect block the
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	878 commands within the unwind_protect_cleanup block are executed before the error
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	879 is thrown. If an error is not thrown, then the unwind_protect_cleanup block is
50bb53905f03 doc: Update documentation for keywords to include classdef statements (Bug #52591). Rik <rik@octave.org> parents: 23219 diff changeset	880 still executed. In other words, the unwind_protect_cleanup code is guaranteed
24691 b658e0fa0cb3 maint: Remove trailing whitespace from files. Rik <rik@octave.org> parents: 24534 diff changeset	881 to execute regardless of success or failure in the unwind_protect block.
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	882 @seealso{unwind_protect_cleanup, try}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	883 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	884 unwind_protect_cleanup
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	885 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	886 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	887 @deftypefn {} {} unwind_protect_cleanup
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	888 Begin the cleanup section of an unwind_protect block.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	889 @seealso{unwind_protect}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	890 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	891 varargin
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	892 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	893 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	894 @deftypefn {} {} varargin
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	895 Pass an arbitrary number of arguments into a function.
32793 8fb76692bbbd Backed out changeset 56995fce2adc John W. Eaton <jwe@octave.org> parents: 32783 diff changeset	896 @seealso{varargout, nargin, isargout, nargout, nthargout}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	897 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	898 varargout
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	899 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	900 -- texinfo --
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	901 @deftypefn {} {} varargout
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	902 Pass an arbitrary number of arguments out of a function.
32793 8fb76692bbbd Backed out changeset 56995fce2adc John W. Eaton <jwe@octave.org> parents: 32783 diff changeset	903 @seealso{varargin, nargin, isargout, nargout, nthargout}
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	904 @end deftypefn
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	905 while
25637 e1c3d1c6e896 don't substitute api.prefix style in bison input files John W. Eaton <jwe@octave.org> parents: 25280 diff changeset	906 @c libinterp/parse-tree/oct-parse.yy
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	907 -- texinfo --
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	908 @deftypefn {} {} while (@var{cond})
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	909 Begin a while loop.
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	910
29512 4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	911 The conditional @var{cond} is true if it is not empty and if @emph{all} values
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	912 are nonzero.
4f555ba551e5 doc: Update keyword docstrings (bug #60275). Rik <rik@octave.org> parents: 29358 diff changeset	913
22156 187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	914 @example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	915 @group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	916 i = 0;
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	917 while (i < 10)
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	918 i++
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	919 endwhile
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	920 @end group
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	921 @end example
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	922 @seealso{do, endwhile, for, until}
187b6727c75e build doc-cache without running Octave (bug #48508) John W. Eaton <jwe@octave.org> parents: diff changeset	923 @end deftypefn

Mercurial > octave

annotate libinterp/op-kw-docs @ 33608:5fba13104493 bytecode-interpreter tip