Mercurial > hg > octave-lyh

diff scripts/general/perror.m @ 3373:36405da8e173

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 1999-11-23 20:54:17 by jwe]
author jwe
date Tue, 23 Nov 1999 20:54:31 +0000
parents d2046ca9a380
children 69b167451491
line wrap: on
line diff
--- a/scripts/general/perror.m
+++ b/scripts/general/perror.m
@@ -17,10 +17,13 @@
 ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 ## 02111-1307, USA.
 
-## usage: perror (name, err)
-##
-## Print an error message for error number `err' from function "name".
-##
+## @deftypefn {Function File} {} perror (@var{name}, @var{num})
+## Print the error message for function @var{name} corresponding to the
+## error number @var{num}.  This function is intended to be used to print
+## useful error messages for those functions that return numeric error
+## codes.
+## @end deftypefn
+
 ## See also: strerror
 
 ## Author: jwe