comparison libinterp/parse-tree/lex.ll @ 18599:04b4fb217b1a stable

doc: Improve documentation strings in parse-tree directory. * lex.ll (F__display_tokens__): Add seealso reference. * lex.ll (F__token_count__): Add seealso reference. * lex.ll (F__lexer_debug_flag__): Document function. * oct-parse.in.yy (Fautoload): Add additional calling form. Rephrase several sentences. * oct-parse.in.yy (Fmfilename): Make single sentence description stand apart from the rest of documentation. * oct-parse.in.yy (Fsource): Make single sentence description stand apart from the rest of documentation. Add seealso link to 'run'. * oct-parse.in.yy (Fbuiltin): Change type to "Built-in Function" from "Loadable Function". * oct-parse.in.yy (Feval): Rephrase several sentences. Add programming note suggesting the use of alternatives like try/catch or unwind_protect. * oct-parse.in.yy (F__parser_debug_flag__): Document function. * pt-mat.cc (Fstring_fill_char): Use semicolon in place of period for stronger idea linkage.
author Rik <rik@octave.org>
date Fri, 28 Feb 2014 14:04:41 -0800
parents e4c319ed2414
children 4cf930a64fad 4293f49795d9
comparison
equal deleted inserted replaced
18598:186ea1c2bbd4 18599:04b4fb217b1a
1779 DEFUN (__display_tokens__, args, nargout, 1779 DEFUN (__display_tokens__, args, nargout,
1780 "-*- texinfo -*-\n\ 1780 "-*- texinfo -*-\n\
1781 @deftypefn {Built-in Function} {} __display_tokens__ ()\n\ 1781 @deftypefn {Built-in Function} {} __display_tokens__ ()\n\
1782 Query or set the internal variable that determines whether Octave's\n\ 1782 Query or set the internal variable that determines whether Octave's\n\
1783 lexer displays tokens as they are read.\n\ 1783 lexer displays tokens as they are read.\n\
1784 @seealso{__lexer_debug_flag__, __token_count__}\n\
1784 @end deftypefn") 1785 @end deftypefn")
1785 { 1786 {
1786 return SET_INTERNAL_VARIABLE (display_tokens); 1787 return SET_INTERNAL_VARIABLE (display_tokens);
1787 } 1788 }
1788 1789
1789 DEFUN (__token_count__, , , 1790 DEFUN (__token_count__, , ,
1790 "-*- texinfo -*-\n\ 1791 "-*- texinfo -*-\n\
1791 @deftypefn {Built-in Function} {} __token_count__ ()\n\ 1792 @deftypefn {Built-in Function} {} __token_count__ ()\n\
1792 Number of language tokens processed since Octave startup.\n\ 1793 Return the number of language tokens processed since Octave startup.\n\
1794 @seealso{__lexer_debug_flag__, __display_tokens__}\n\
1793 @end deftypefn") 1795 @end deftypefn")
1794 { 1796 {
1795 return octave_value (Vtoken_count); 1797 return octave_value (Vtoken_count);
1796 } 1798 }
1797 1799
1798 DEFUN (__lexer_debug_flag__, args, nargout, 1800 DEFUN (__lexer_debug_flag__, args, nargout,
1799 "-*- texinfo -*-\n\ 1801 "-*- texinfo -*-\n\
1800 @deftypefn {Built-in Function} {@var{old_val} =} __lexer_debug_flag__ (@var{new_val}))\n\ 1802 @deftypefn {Built-in Function} {@var{val} =} __lexer_debug_flag__ ()\n\
1801 Undocumented internal function.\n\ 1803 @deftypefnx {Built-in Function} {@var{old_val} =} __lexer_debug_flag__ (@var{new_val})\n\
1804 Query or set the internal flag that determines whether Octave's lexer prints\n\
1805 debug information as it processes an expression.\n\
1806 @seealso{__display_tokens__, __token_count__, __parse_debug_flag__}\n\
1802 @end deftypefn") 1807 @end deftypefn")
1803 { 1808 {
1804 octave_value retval; 1809 octave_value retval;
1805 1810
1806 retval = set_internal_variable (lexer_debug_flag, args, nargout, 1811 retval = set_internal_variable (lexer_debug_flag, args, nargout,