Mercurial > hg > octave-lyh

comparison src/help.cc @ 12519:91ccd08fe80c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add gen_doc_cache, get_help_text, get_help_text_from_file, get_first_help_sentence to documentation.
author Rik <octave@nomad.inbox5.com>
date Fri, 18 Mar 2011 14:38:46 -0700
parents 7a5aacf65f81
children 307e177dbaa8
comparison
equal deleted inserted replaced
12518:9f926b9f83cc 12519:91ccd08fe80c
717 } 717 }
718 } 718 }
719 719
720 DEFUN (get_help_text, args, , "-*- texinfo -*-\n\ 720 DEFUN (get_help_text, args, , "-*- texinfo -*-\n\
721 @deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\ 721 @deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\
722 Return the help text of a given function.\n\ 722 Return the raw help text of function @var{name}.\n\
723 \n\ 723 \n\
724 This function returns the raw help text @var{text} and an indication of\n\ 724 The raw help text is returned in @var{text} and the format in @var{format}\n\
725 its format for the function @var{name}. The format indication @var{format}\n\ 725 The format is a string which is one of @t{\"texinfo\"}, @t{\"html\"}, or\n\
726 is a string that can be either @t{\"texinfo\"}, @t{\"html\"}, or\n\
727 @t{\"plain text\"}.\n\ 726 @t{\"plain text\"}.\n\
728 \n\
729 To convert the help text to other formats, use the @code{makeinfo} function.\n\
730 \n\
731 @seealso{makeinfo}\n\
732 @end deftypefn") 727 @end deftypefn")
733 { 728 {
734 octave_value_list retval; 729 octave_value_list retval;
735 730
736 if (args.length () == 1) 731 if (args.length () == 1)
791 } 786 }
792 787
793 DEFUN (get_help_text_from_file, args, , 788 DEFUN (get_help_text_from_file, args, ,
794 "-*- texinfo -*-\n\ 789 "-*- texinfo -*-\n\
795 @deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname})\n\ 790 @deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname})\n\
796 Return the help text from the given file.\n\ 791 Return the raw help text from the file @var{fname}.\n\
797 \n\ 792 \n\
798 This function returns the raw help text @var{text} and an indication of\n\ 793 The raw help text is returned in @var{text} and the format in @var{format}\n\
799 its format for the function @var{name}. The format indication @var{format}\n\ 794 The format is a string which is one of @t{\"texinfo\"}, @t{\"html\"}, or\n\
800 is a string that can be either @t{\"texinfo\"}, @t{\"html\"}, or\n\
801 @t{\"plain text\"}.\n\ 795 @t{\"plain text\"}.\n\
802 \n\
803 To convert the help text to other formats, use the @code{makeinfo} function.\n\
804 \n\
805 @seealso{makeinfo}\n\
806 @end deftypefn") 796 @end deftypefn")
807 { 797 {
808 octave_value_list retval; 798 octave_value_list retval;
809 799
810 if (args.length () == 1) 800 if (args.length () == 1)