Mercurial > octave-nkf
diff 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 |
line wrap: on
line diff
--- a/src/error.cc Mon Oct 15 08:34:33 2012 -0400 +++ b/src/error.cc Mon Oct 15 07:18:31 2012 -0700 @@ -1109,8 +1109,10 @@ to go on.\n\ \n\ The optional message identifier allows users to enable or disable\n\ -warnings tagged by @var{id}. The special identifier @samp{\"all\"} may\n\ -be used to set the state of all warnings.\n\ +warnings tagged by @var{id}. A message identifier is of the form\n\ +\"NAMESPACE:WARNING-NAME\". Octave's own warnings use the \"Octave\"\n\ +namespace (@pxref{doc-warning_ids}). The special identifier @samp{\"all\"}\n\ +may be used to set the state of all warnings.\n\ \n\ If the first argument is @samp{\"on\"} or @samp{\"off\"}, set the state\n\ of a particular warning using the identifier @var{id}. If the first\n\