Mercurial > octave-nkf

comparison src/help.cc @ 6620:bf4bdc21dc8d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-05-14 17:35:46 by jwe]
author jwe
date Mon, 14 May 2007 17:38:38 +0000
parents 687ae48b2253
children 8b0cfeb06365
comparison
equal deleted inserted replaced
6619:b2b3b0509586 6620:bf4bdc21dc8d
1230 "-*- texinfo -*-\n\ 1230 "-*- texinfo -*-\n\
1231 \n\ 1231 \n\
1232 @deffn {Command} type options name @dots{}\n\ 1232 @deffn {Command} type options name @dots{}\n\
1233 Display the definition of each @var{name} that refers to a function.\n\ 1233 Display the definition of each @var{name} that refers to a function.\n\
1234 \n\ 1234 \n\
1235 Normally also displays if each @var{name} is user-defined or builtin;\n\ 1235 Normally also displays whether each @var{name} is user-defined or built-in;\n\
1236 the @code{-q} option suppresses this behaviour.\n\ 1236 the @code{-q} option suppresses this behaviour.\n\
1237 \n\
1238 Currently, Octave can only display functions that can be compiled\n\
1239 cleanly, because it uses its internal representation of the function to\n\
1240 recreate the program text.\n\
1241 \n\
1242 Comments are not displayed because Octave's parser currently discards\n\
1243 them as it converts the text of a function file to its internal\n\
1244 representation. This problem may be fixed in a future release.\n\
1245 @end deffn") 1237 @end deffn")
1246 { 1238 {
1247 octave_value retval; 1239 octave_value retval;
1248 1240
1249 int argc = args.length () + 1; 1241 int argc = args.length () + 1;
1762 @var{helpstring} define the matching functions and the first sentence of\n\ 1754 @var{helpstring} define the matching functions and the first sentence of\n\
1763 each of their help strings.\n\ 1755 each of their help strings.\n\
1764 \n\ 1756 \n\
1765 Note that the ability of @code{lookfor} to correctly identify the first\n\ 1757 Note that the ability of @code{lookfor} to correctly identify the first\n\
1766 sentence of the help of the functions is dependent on the format of the\n\ 1758 sentence of the help of the functions is dependent on the format of the\n\
1767 functions help. All of the functions in octave itself will correctly\n\ 1759 functions help. All of the functions in Octave itself will correctly\n\
1768 find the first sentence, but the same can not be guaranteed for other\n\ 1760 find the first sentence, but the same can not be guaranteed for other\n\
1769 functions. Therefore the use of the '-all' argument might be necessary\n\ 1761 functions. Therefore the use of the '-all' argument might be necessary\n\
1770 to find related functions that are not part of octave.\n\ 1762 to find related functions that are not part of Octave.\n\
1771 @seealso{help, which}\n\ 1763 @seealso{help, which}\n\
1772 @end deffn") 1764 @end deffn")
1773 { 1765 {
1774 octave_value_list retval; 1766 octave_value_list retval;
1775 int nargin = args.length (); 1767 int nargin = args.length ();