comparison src/oct-hist.cc @ 10840:89f4d7e294cc

Grammarcheck .cc files
author Rik <octave@nomad.inbox5.com>
date Sat, 31 Jul 2010 11:18:11 -0700
parents 479cc8a0a846
children 944b7e20fc5a
comparison
equal deleted inserted replaced
10839:65bc065bec95 10840:89f4d7e294cc
540 540
541 DEFUN (edit_history, args, , 541 DEFUN (edit_history, args, ,
542 "-*- texinfo -*-\n\ 542 "-*- texinfo -*-\n\
543 @deffn {Command} edit_history [@var{first}] [@var{last}]\n\ 543 @deffn {Command} edit_history [@var{first}] [@var{last}]\n\
544 If invoked with no arguments, @code{edit_history} allows you to edit the\n\ 544 If invoked with no arguments, @code{edit_history} allows you to edit the\n\
545 history list using the editor named by the variable @w{@code{EDITOR}}. The\n\ 545 history list using the editor named by the variable @w{@env{EDITOR}}. The\n\
546 commands to be edited are first copied to a temporary file. When you\n\ 546 commands to be edited are first copied to a temporary file. When you\n\
547 exit the editor, Octave executes the commands that remain in the file.\n\ 547 exit the editor, Octave executes the commands that remain in the file.\n\
548 It is often more convenient to use @code{edit_history} to define functions \n\ 548 It is often more convenient to use @code{edit_history} to define functions \n\
549 rather than attempting to enter them directly on the command line.\n\ 549 rather than attempting to enter them directly on the command line.\n\
550 By default, the block of commands is executed as soon as you exit the\n\ 550 By default, the block of commands is executed as soon as you exit the\n\
654 return retval; 654 return retval;
655 } 655 }
656 656
657 DEFUN (history_size, args, nargout, 657 DEFUN (history_size, args, nargout,
658 "-*- texinfo -*-\n\ 658 "-*- texinfo -*-\n\
659 @deftypefn {Built-in Function} {@var{val} =} history_size ()\n\ 659 @deftypefn {Built-in Function} {@var{val} =} history_size ()\n\
660 @deftypefnx {Built-in Function} {@var{old_val} =} history_size (@var{new_val})\n\ 660 @deftypefnx {Built-in Function} {@var{old_val} =} history_size (@var{new_val})\n\
661 Query or set the internal variable that specifies how many entries\n\ 661 Query or set the internal variable that specifies how many entries\n\
662 to store in the history file. The default value is @code{1024},\n\ 662 to store in the history file. The default value is @code{1024},\n\
663 but may be overridden by the environment variable @w{@code{OCTAVE_HISTSIZE}}.\n\ 663 but may be overridden by the environment variable @w{@env{OCTAVE_HISTSIZE}}.\n\
664 @seealso{history_file, history_timestamp_format_string, saving_history}\n\ 664 @seealso{history_file, history_timestamp_format_string, saving_history}\n\
665 @end deftypefn") 665 @end deftypefn")
666 { 666 {
667 int saved_history_size = Vhistory_size; 667 int saved_history_size = Vhistory_size;
668 668
675 return retval; 675 return retval;
676 } 676 }
677 677
678 DEFUN (history_file, args, nargout, 678 DEFUN (history_file, args, nargout,
679 "-*- texinfo -*-\n\ 679 "-*- texinfo -*-\n\
680 @deftypefn {Built-in Function} {@var{val} =} history_file ()\n\ 680 @deftypefn {Built-in Function} {@var{val} =} history_file ()\n\
681 @deftypefnx {Built-in Function} {@var{old_val} =} history_file (@var{new_val})\n\ 681 @deftypefnx {Built-in Function} {@var{old_val} =} history_file (@var{new_val})\n\
682 Query or set the internal variable that specifies the name of the\n\ 682 Query or set the internal variable that specifies the name of the\n\
683 file used to store command history. The default value is\n\ 683 file used to store command history. The default value is\n\
684 @file{~/.octave_hist}, but may be overridden by the environment\n\ 684 @file{~/.octave_hist}, but may be overridden by the environment\n\
685 variable @w{@code{OCTAVE_HISTFILE}}.\n\ 685 variable @w{@env{OCTAVE_HISTFILE}}.\n\
686 @seealso{history_size, saving_history, history_timestamp_format_string}\n\ 686 @seealso{history_size, saving_history, history_timestamp_format_string}\n\
687 @end deftypefn") 687 @end deftypefn")
688 { 688 {
689 std::string saved_history_file = Vhistory_file; 689 std::string saved_history_file = Vhistory_file;
690 690
696 return retval; 696 return retval;
697 } 697 }
698 698
699 DEFUN (history_timestamp_format_string, args, nargout, 699 DEFUN (history_timestamp_format_string, args, nargout,
700 "-*- texinfo -*-\n\ 700 "-*- texinfo -*-\n\
701 @deftypefn {Built-in Function} {@var{val} =} history_timestamp_format_string ()\n\ 701 @deftypefn {Built-in Function} {@var{val} =} history_timestamp_format_string ()\n\
702 @deftypefnx {Built-in Function} {@var{old_val} =} history_timestamp_format_string (@var{new_val})\n\ 702 @deftypefnx {Built-in Function} {@var{old_val} =} history_timestamp_format_string (@var{new_val})\n\
703 Query or set the internal variable that specifies the format string\n\ 703 Query or set the internal variable that specifies the format string\n\
704 for the comment line that is written to the history file when Octave\n\ 704 for the comment line that is written to the history file when Octave\n\
705 exits. The format string is passed to @code{strftime}. The default\n\ 705 exits. The format string is passed to @code{strftime}. The default\n\
706 value is\n\ 706 value is\n\
714 return SET_INTERNAL_VARIABLE (history_timestamp_format_string); 714 return SET_INTERNAL_VARIABLE (history_timestamp_format_string);
715 } 715 }
716 716
717 DEFUN (saving_history, args, nargout, 717 DEFUN (saving_history, args, nargout,
718 "-*- texinfo -*-\n\ 718 "-*- texinfo -*-\n\
719 @deftypefn {Built-in Function} {@var{val} =} saving_history ()\n\ 719 @deftypefn {Built-in Function} {@var{val} =} saving_history ()\n\
720 @deftypefnx {Built-in Function} {@var{old_val} =} saving_history (@var{new_val})\n\ 720 @deftypefnx {Built-in Function} {@var{old_val} =} saving_history (@var{new_val})\n\
721 Query or set the internal variable that controls whether commands entered\n\ 721 Query or set the internal variable that controls whether commands entered\n\
722 on the command line are saved in the history file.\n\ 722 on the command line are saved in the history file.\n\
723 @seealso{history_file, history_size, history_timestamp_format_string}\n\ 723 @seealso{history_file, history_size, history_timestamp_format_string}\n\
724 @end deftypefn") 724 @end deftypefn")