comparison libinterp/parse-tree/pt-mat.cc @ 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 175b392e91fe
children f958e8cd6348 2304ddfd736f
comparison
equal deleted inserted replaced
18598:186ea1c2bbd4 18599:04b4fb217b1a
1372 "-*- texinfo -*-\n\ 1372 "-*- texinfo -*-\n\
1373 @deftypefn {Built-in Function} {@var{val} =} string_fill_char ()\n\ 1373 @deftypefn {Built-in Function} {@var{val} =} string_fill_char ()\n\
1374 @deftypefnx {Built-in Function} {@var{old_val} =} string_fill_char (@var{new_val})\n\ 1374 @deftypefnx {Built-in Function} {@var{old_val} =} string_fill_char (@var{new_val})\n\
1375 @deftypefnx {Built-in Function} {} string_fill_char (@var{new_val}, \"local\")\n\ 1375 @deftypefnx {Built-in Function} {} string_fill_char (@var{new_val}, \"local\")\n\
1376 Query or set the internal variable used to pad all rows of a character\n\ 1376 Query or set the internal variable used to pad all rows of a character\n\
1377 matrix to the same length. It must be a single character. The default\n\ 1377 matrix to the same length; It must be a single character. The default\n\
1378 value is @qcode{\" \"} (a single space). For example:\n\ 1378 value is @qcode{\" \"} (a single space). For example:\n\
1379 \n\ 1379 \n\
1380 @example\n\ 1380 @example\n\
1381 @group\n\ 1381 @group\n\
1382 string_fill_char (\"X\");\n\ 1382 string_fill_char (\"X\");\n\