octave-nkf: scripts/miscellaneous/warning

annotate scripts/miscellaneous/warning_ids.m @ 12575:d0b799dafede

Grammarcheck files for 3.4.1 release.

author	Rik <octave@nomad.inbox5.com>
date	Mon, 04 Apr 2011 15:33:46 -0700
parents	32279948bf3b
children	a1e386b9ef4b

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 10846 diff changeset	1 ## Copyright (C) 2006-2011 John W. Eaton
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	2 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	3 ## This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	4 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	13 ## General Public License for more details.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	14 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	15 ## You should have received a copy of the GNU General Public License
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	17 ## <http://www.gnu.org/licenses/>.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6555 diff changeset	18
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	20 ## @table @code
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	21 ## @item Octave:array-to-scalar
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	22 ## If the @code{Octave:array-to-scalar} warning is enabled, Octave will
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	23 ## warn when an implicit conversion from an array to a scalar value is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	24 ## attempted. By default, the @code{Octave:array-to-scalar} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	25 ## disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	26 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	27 ## @item Octave:array-to-vector
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	28 ## If the @code{Octave:array-to-vector} warning is enabled, Octave will
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	29 ## warn when an implicit conversion from an array to a vector value is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	30 ## attempted. By default, the @code{Octave:array-to-vector} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	31 ## disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	32 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	33 ## @item Octave:assign-as-truth-value
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	34 ## If the @code{Octave:assign-as-truth-value} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	35 ## enabled, a warning is issued for statements like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	36 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	37 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	38 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	39 ## if (s = t)
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	40 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	41 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	42 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	43 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	44 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	45 ## since such statements are not common, and it is likely that the intent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	46 ## was to write
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	47 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	48 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	49 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	50 ## if (s == t)
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	51 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	52 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	53 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	54 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	55 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	56 ## instead.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	57 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	58 ## There are times when it is useful to write code that contains
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	59 ## assignments within the condition of a @code{while} or @code{if}
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	60 ## statement. For example, statements like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	61 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	62 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	63 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	64 ## while (c = getc())
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	65 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	66 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	67 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	68 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	69 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	70 ## are common in C programming.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	71 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	72 ## It is possible to avoid all warnings about such statements by
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	73 ## disabling the @code{Octave:assign-as-truth-value} warning,
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	74 ## but that may also let real errors like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	75 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	76 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	77 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	78 ## if (x = 1) # intended to test (x == 1)!
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	79 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	80 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	81 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	82 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	83 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	84 ## slip by.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	85 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	86 ## In such cases, it is possible suppress errors for specific statements by
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	87 ## writing them with an extra set of parentheses. For example, writing the
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	88 ## previous example as
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	89 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	90 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	91 ## @group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	92 ## while ((c = getc()))
9039 51dc9691f23f Cleanup documentation files errors.texi, debug.texi, io.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	93 ## @dots{}
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	94 ## @end group
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	95 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	96 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	97 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	98 ## will prevent the warning from being printed for this statement, while
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	99 ## allowing Octave to warn about other assignments used in conditional
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	100 ## contexts.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	101 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	102 ## By default, the @code{Octave:assign-as-truth-value} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	103 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	104 ## @item Octave:associativity-change
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	105 ## If the @code{Octave:associativity-change} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	106 ## enabled, Octave will warn about possible changes in the meaning of
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	107 ## some code due to changes in associativity for some operators.
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	108 ## Associativity changes have typically been made for @sc{matlab}
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	109 ## compatibility. By default, the @code{Octave:associativity-change}
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	110 ## warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	111 ##
12486 32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	112 ## @item Octave:autoload-relative-file-name
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	113 ## If the @code{Octave:autoload-relative-file-name} is enabled,
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	114 ## Octave will warn when parsing autoload() function calls with relative
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	115 ## paths to function files. This usually happens when using autoload()
12486 32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	116 ## calls in PKG_ADD files, when the PKG_ADD file is not in the same
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	117 ## directory as the .oct file referred to by the autoload() command.
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	118 ## By default, the @code{Octave:autoload-relative-file-name}
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	119 ## warning is enabled.
32279948bf3b Document the Octave:autoload-relative-file-name warning. Thomas Weber <tweber@debian.org> parents: 12477 diff changeset	120 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	121 ## @item Octave:divide-by-zero
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	122 ## If the @code{Octave:divide-by-zero} warning is enabled, a
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	123 ## warning is issued when Octave encounters a division by zero. By
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	124 ## default, the @code{Octave:divide-by-zero} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	125 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	126 ## @item Octave:empty-list-elements
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	127 ## If the @code{Octave:empty-list-elements} warning is enabled, a
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	128 ## warning is issued when an empty matrix is found in a matrix list.
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	129 ## For example:
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	130 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	131 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	132 ## a = [1, [], 3, [], 5]
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	133 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	134 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	135 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	136 ## By default, the @code{Octave:empty-list-elements} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	137 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	138 ## @item Octave:fortran-indexing
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	139 ## If the @code{Octave:fortran-indexing} warning is enabled, a warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	140 ## printed for expressions which select elements of a two-dimensional matrix
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	141 ## using a single index. By default, the @code{Octave:fortran-indexing}
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	142 ## warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	143 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	144 ## @item Octave:function-name-clash
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	145 ## If the @code{Octave:function-name-clash} warning is enabled, a
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	146 ## warning is issued when Octave finds that the name of a function
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	147 ## defined in a function file differs from the name of the file. (If
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	148 ## the names disagree, the name declared inside the file is ignored.)
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	149 ## By default, the @code{Octave:function-name-clash} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	150 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	151 ## @item Octave:future-time-stamp
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	152 ## If the @code{Octave:future-time-stamp} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	153 ## will print a warning if it finds a function file with a time stamp
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	154 ## that is in the future. By default, the
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	155 ## @code{Octave:future-time-stamp} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	156 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	157 ## @item Octave:imag-to-real
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	158 ## If the @code{Octave:imag-to-real} warning is enabled, a warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	159 ## printed for implicit conversions of complex numbers to real numbers.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	160 ## By default, the @code{Octave:imag-to-real} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	161 ##
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	162 ## @item Octave:matlab-incompatible
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	163 ## Print warnings for Octave language features that may cause
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	164 ## compatibility problems with @sc{matlab}.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	165 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	166 ## @item Octave:missing-semicolon
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	167 ## If the @code{Octave:missing-semicolon} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	168 ## will warn when statements in function definitions don't end in
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	169 ## semicolons. By default the @code{Octave:missing-semicolon} warning
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	170 ## is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	171 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	172 ## @item Octave:neg-dim-as-zero
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	173 ## If the @code{Octave:neg-dim-as-zero} warning is enabled, print a warning
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	174 ## for expressions like
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	175 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	176 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	177 ## eye (-1)
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	178 ## @end example
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	179 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	180 ## @noindent
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	181 ## By default, the @code{Octave:neg-dim-as-zero} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	182 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	183 ## @item Octave:num-to-str
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	184 ## If the @code{Octave:num-to-str} warning is enable, a warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	185 ## printed for implicit conversions of numbers to their ASCII character
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	186 ## equivalents when strings are constructed using a mixture of strings and
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	187 ## numbers in matrix notation. For example,
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	188 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	189 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	190 ## @group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	191 ## [ "f", 111, 111 ]
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	192 ## @result{} "foo"
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	193 ## @end group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	194 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	195 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	196 ## @noindent
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	197 ## elicits a warning if the @code{Octave:num-to-str} warning is
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	198 ## enabled. By default, the @code{Octave:num-to-str} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	199 ##
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	200 ## @item Octave:possible-matlab-short-circuit-operator
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	201 ## If the @code{Octave:possible-matlab-short-circuit-operator} warning
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	202 ## is enabled, Octave will warn about using the not short circuiting
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	203 ## operators @code{&} and @code{\|} inside @code{if} or @code{while}
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	204 ## conditions. They normally never short circuit, but @sc{matlab} always
d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	205 ## short circuits if any logical operators are used in a condition. You
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	206 ## can turn on the option
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	207 ##
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	208 ## @example
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	209 ## @group
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	210 ## do_braindead_shortcircuit_evaluation(1)
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	211 ## @end group
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	212 ## @end example
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	213 ##
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	214 ## @noindent
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	215 ## if you would like to enable this short-circuit evaluation in
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	216 ## Octave. Note that the @code{&&} and @code{\|\|} operators always short
d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	217 ## circuit in both Octave and @sc{matlab}, so it's only necessary to
d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 12486 diff changeset	218 ## enable @sc{matlab}-style short-circuiting it's too arduous to modify
12477 d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	219 ## existing code that relies on this behaviour.
d1466d956d17 Add a warning description for Matlab-style short-circuiting Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 11587 diff changeset	220 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	221 ## @item Octave:precedence-change
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	222 ## If the @code{Octave:precedence-change} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	223 ## will warn about possible changes in the meaning of some code due to
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	224 ## changes in precedence for some operators. Precedence changes have
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 9039 diff changeset	225 ## typically been made for @sc{matlab} compatibility. By default, the
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	226 ## @code{Octave:precedence-change} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	227 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	228 ## @item Octave:reload-forces-clear
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	229 ## If several functions have been loaded from the same file, Octave must
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	230 ## clear all the functions before any one of them can be reloaded. If
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	231 ## the @code{Octave:reload-forces-clear} warning is enabled, Octave will
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	232 ## warn you when this happens, and print a list of the additional
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	233 ## functions that it is forced to clear. By default, the
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	234 ## @code{Octave:reload-forces-clear} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	235 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	236 ## @item Octave:resize-on-range-error
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	237 ## If the @code{Octave:resize-on-range-error} warning is enabled, print a
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	238 ## warning when a matrix is resized by an indexed assignment with
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	239 ## indices outside the current bounds. By default, the
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	240 ## @code{Octave:resize-on-range-error} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	241 ##
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	242 ## @item Octave:separator-insert
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	243 ## Print warning if commas or semicolons might be inserted
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	244 ## automatically in literal matrices.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	245 ##
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	246 ## @item Octave:single-quote-string
8325 b93ac0586e4b spelling corrections Brian Gough<bjg@network-theory.co.uk> parents: 7017 diff changeset	247 ## Print warning if a single quote character is used to introduce a
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5781 diff changeset	248 ## string constant.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	249 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	250 ## @item Octave:str-to-num
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	251 ## If the @code{Octave:str-to-num} warning is enabled, a warning is printed
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	252 ## for implicit conversions of strings to their numeric ASCII equivalents.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	253 ## For example,
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	254 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	255 ## @example
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	256 ## @group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	257 ## "abc" + 0
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	258 ## @result{} 97 98 99
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	259 ## @end group
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	260 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	261 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10821 diff changeset	262 ## @noindent
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	263 ## elicits a warning if the @code{Octave:str-to-num} warning is enabled.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	264 ## By default, the @code{Octave:str-to-num} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	265 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	266 ## @item Octave:string-concat
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	267 ## If the @code{Octave:string-concat} warning is enabled, print a
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	268 ## warning when concatenating a mixture of double and single quoted strings.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	269 ## By default, the @code{Octave:string-concat} warning is disabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	270 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	271 ## @item Octave:undefined-return-values
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	272 ## If the @code{Octave:undefined-return-values} warning is disabled,
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	273 ## print a warning if a function does not define all the values in
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	274 ## the return list which are expected. By default, the
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	275 ## @code{Octave:undefined-return-values} warning is enabled.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	276 ##
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	277 ## @item Octave:variable-switch-label
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	278 ## If the @code{Octave:variable-switch-label} warning is enabled, Octave
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	279 ## will print a warning if a switch label is not a constant or constant
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	280 ## expression. By default, the @code{Octave:variable-switch-label}
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	281 ## warning is disabled.
faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: diff changeset	282 ## @end table
8673 9e0f0a7bf858 warning_ids.m: make it a function that just calls help John W. Eaton <jwe@octave.org> parents: 8325 diff changeset	283
9e0f0a7bf858 warning_ids.m: make it a function that just calls help John W. Eaton <jwe@octave.org> parents: 8325 diff changeset	284 function warning_ids ()
9e0f0a7bf858 warning_ids.m: make it a function that just calls help John W. Eaton <jwe@octave.org> parents: 8325 diff changeset	285 help ("warning_ids");
9e0f0a7bf858 warning_ids.m: make it a function that just calls help John W. Eaton <jwe@octave.org> parents: 8325 diff changeset	286 endfunction

Mercurial > octave-nkf

annotate scripts/miscellaneous/warning_ids.m @ 12575:d0b799dafede