Mercurial > hg > octave-lyh
comparison src/error.cc @ 15524:15628a84a4fa stable
Document form of warning IDs is NAMESPACE:WARNING-NAME (bug #37559)
* errors.txi: Add explanation of warning ID form to documentation.
Correct example code to properly use warning IDs.
* error.cc (Fwarning): Document form of warning ID in warning()
docstring.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 15 Oct 2012 07:18:31 -0700 |
parents | d174210ce1ec |
children | 63d024333bee |
comparison
equal
deleted
inserted
replaced
15522:7f7a07657be4 | 15524:15628a84a4fa |
---|---|
1107 You should use this function when you want to notify the user\n\ | 1107 You should use this function when you want to notify the user\n\ |
1108 of an unusual condition, but only when it makes sense for your program\n\ | 1108 of an unusual condition, but only when it makes sense for your program\n\ |
1109 to go on.\n\ | 1109 to go on.\n\ |
1110 \n\ | 1110 \n\ |
1111 The optional message identifier allows users to enable or disable\n\ | 1111 The optional message identifier allows users to enable or disable\n\ |
1112 warnings tagged by @var{id}. The special identifier @samp{\"all\"} may\n\ | 1112 warnings tagged by @var{id}. A message identifier is of the form\n\ |
1113 be used to set the state of all warnings.\n\ | 1113 \"NAMESPACE:WARNING-NAME\". Octave's own warnings use the \"Octave\"\n\ |
1114 namespace (@pxref{doc-warning_ids}). The special identifier @samp{\"all\"}\n\ | |
1115 may be used to set the state of all warnings.\n\ | |
1114 \n\ | 1116 \n\ |
1115 If the first argument is @samp{\"on\"} or @samp{\"off\"}, set the state\n\ | 1117 If the first argument is @samp{\"on\"} or @samp{\"off\"}, set the state\n\ |
1116 of a particular warning using the identifier @var{id}. If the first\n\ | 1118 of a particular warning using the identifier @var{id}. If the first\n\ |
1117 argument is @samp{\"query\"}, query the state of this warning instead.\n\ | 1119 argument is @samp{\"query\"}, query the state of this warning instead.\n\ |
1118 If the identifier is omitted, a value of @samp{\"all\"} is assumed. If\n\ | 1120 If the identifier is omitted, a value of @samp{\"all\"} is assumed. If\n\ |