Mercurial > hg > octave-lyh

comparison src/help.cc @ 3361:4f40efa995c1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 1999-11-19 21:19:37 by jwe]
author jwe
date Fri, 19 Nov 1999 21:19:44 +0000
parents d2e12e998a78
children 36405da8e173
comparison
equal deleted inserted replaced
3360:48bd8127e19b 3361:4f40efa995c1
827 error ("type: `%s' undefined", name.c_str ()); 827 error ("type: `%s' undefined", name.c_str ());
828 } 828 }
829 } 829 }
830 830
831 DEFUN_TEXT (type, args, nargout, 831 DEFUN_TEXT (type, args, nargout,
832 "type NAME\n\ 832 "-*- texinfo -*-\n\
833 \n\ 833 \n\
834 display the definition of each NAME that refers to a function") 834 @deffn {Command} type options name @dots{}\n\
835 Display the definition of each @var{name} that refers to a function.\n\
836 \n\
837 Normally also displays if each @var{name} is user-defined or builtin;\n\
838 the @code{-q} option suppresses this behaviour.\n\
839 \n\
840 Currently, Octave can only display functions that can be compiled\n\
841 cleanly, because it uses its internal representation of the function to\n\
842 recreate the program text.\n\
843 \n\
844 Comments are not displayed because Octave's parser currently discards\n\
845 them as it converts the text of a function file to its internal\n\
846 representation. This problem may be fixed in a future release.\n\
847 @end deffn")
835 { 848 {
836 octave_value_list retval; 849 octave_value_list retval;
837 850
838 unwind_protect::begin_frame ("Ftype"); 851 unwind_protect::begin_frame ("Ftype");
839 852
942 os << "which: `" << name << "' is undefined\n"; 955 os << "which: `" << name << "' is undefined\n";
943 } 956 }
944 } 957 }
945 958
946 DEFUN_TEXT (which, args, nargout, 959 DEFUN_TEXT (which, args, nargout,
947 "which NAME ...\n\ 960 "-*- texinfo -*-\n\
948 \n\ 961 @deffn {Command} which name @dots{}\n\
949 display the type of each NAME. If NAME is defined from an function\n\ 962 Display the type of each @var{name}. If @var{name} is defined from a\n\
950 file, print the full name of the file.") 963 function file, the full name of the file is also displayed.\n\
964 @end deffn")
951 { 965 {
952 octave_value_list retval; 966 octave_value_list retval;
953 967
954 string_vector argv = args.make_argv ("which"); 968 string_vector argv = args.make_argv ("which");
955 969