comparison libinterp/corefcn/variables.cc @ 17756:9aff1c9fd70f

doc: Add missing functions to manual. * doc/interpreter/doccheck/mk_undocumented_list: Mark 'end' as an exception not required to be in manual. * doc/interpreter/gui.txi: Add isguirunning() and desktop() to list of GUI utility functions. * doc/interpreter/octave.texi: Add new subsection "Missing Components" to menu. * doc/interpreter/package.txi: Add "Missing Components" section with DOCSTRING reference for missing_component_hook(). * libinterp/corefcn/variables.cc: Add seealso links between missing_component_hook() and missing_function_hook(). * libinterp/parse-tree/pt-arg-list.cc(Fend): Write docstring for 'end' index keyword.
author Rik <rik@octave.org>
date Thu, 24 Oct 2013 14:44:23 -0700
parents d63878346099
children 175b392e91fe
comparison
equal deleted inserted replaced
17755:9c03b071fd7b 17756:9aff1c9fd70f
2554 an unknown identifier is requested.\n\ 2554 an unknown identifier is requested.\n\
2555 \n\ 2555 \n\
2556 When called from inside a function with the @qcode{\"local\"} option, the\n\ 2556 When called from inside a function with the @qcode{\"local\"} option, the\n\
2557 variable is changed locally for the function and any subroutines it calls. \n\ 2557 variable is changed locally for the function and any subroutines it calls. \n\
2558 The original variable value is restored when exiting the function.\n\ 2558 The original variable value is restored when exiting the function.\n\
2559 @seealso{missing_component_hook}\n\
2559 @end deftypefn") 2560 @end deftypefn")
2560 { 2561 {
2561 return SET_INTERNAL_VARIABLE (missing_function_hook); 2562 return SET_INTERNAL_VARIABLE (missing_function_hook);
2562 } 2563 }
2563 2564
2630 @end example\n\ 2631 @end example\n\
2631 \n\ 2632 \n\
2632 Octave will call @var{fcn} with the name of the function that requires the\n\ 2633 Octave will call @var{fcn} with the name of the function that requires the\n\
2633 component and a string describing the missing component. The hook function\n\ 2634 component and a string describing the missing component. The hook function\n\
2634 should return an error message to be displayed.\n\ 2635 should return an error message to be displayed.\n\
2636 @seealso{missing_function_hook}\n\
2635 @end deftypefn") 2637 @end deftypefn")
2636 { 2638 {
2637 return SET_INTERNAL_VARIABLE (missing_component_hook); 2639 return SET_INTERNAL_VARIABLE (missing_component_hook);
2638 } 2640 }