Mercurial > hg > octave-nkf
diff 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 |
line wrap: on
line diff
--- a/libinterp/parse-tree/lex.ll +++ b/libinterp/parse-tree/lex.ll @@ -1781,6 +1781,7 @@ @deftypefn {Built-in Function} {} __display_tokens__ ()\n\ Query or set the internal variable that determines whether Octave's\n\ lexer displays tokens as they are read.\n\ +@seealso{__lexer_debug_flag__, __token_count__}\n\ @end deftypefn") { return SET_INTERNAL_VARIABLE (display_tokens); @@ -1789,7 +1790,8 @@ DEFUN (__token_count__, , , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} __token_count__ ()\n\ -Number of language tokens processed since Octave startup.\n\ +Return the number of language tokens processed since Octave startup.\n\ +@seealso{__lexer_debug_flag__, __display_tokens__}\n\ @end deftypefn") { return octave_value (Vtoken_count); @@ -1797,8 +1799,11 @@ DEFUN (__lexer_debug_flag__, args, nargout, "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {@var{old_val} =} __lexer_debug_flag__ (@var{new_val}))\n\ -Undocumented internal function.\n\ +@deftypefn {Built-in Function} {@var{val} =} __lexer_debug_flag__ ()\n\ +@deftypefnx {Built-in Function} {@var{old_val} =} __lexer_debug_flag__ (@var{new_val})\n\ +Query or set the internal flag that determines whether Octave's lexer prints\n\ +debug information as it processes an expression.\n\ +@seealso{__display_tokens__, __token_count__, __parse_debug_flag__}\n\ @end deftypefn") { octave_value retval;