Mercurial > octave-nkf

comparison libinterp/corefcn/debug.cc @ 18380:b48391da83fc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Improve docstrings for dbstop, dbup, dbdown. * debug.cc (Fdbstop): Add more calling forms to docstring. Cleanup language in docstring. * debug.cc (Fdbup, Fdbdown): Change the @deftypefn entry to "Command" from "Built-in Function" since this is how they are normally used.
author Rik <rik@octave.org>
date Fri, 24 Jan 2014 17:12:39 -0800
parents 80d39575fd44
children 5b7b12e16523
comparison
equal deleted inserted replaced
18379:80d39575fd44 18380:b48391da83fc
631 return retval; 631 return retval;
632 } 632 }
633 633
634 DEFUN (dbstop, args, , 634 DEFUN (dbstop, args, ,
635 "-*- texinfo -*-\n\ 635 "-*- texinfo -*-\n\
636 @deftypefn {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\")\n\ 636 @deftypefn {Command} dbstop @var{func}\n\
637 @deftypefnx {Command} dbstop @var{func} @var{line}\n\
638 @deftypefnx {Command} dbstop @var{func} @var{line1} @var{line2} @dots{}\n\
639 @deftypefnx {Command} {} dbstop @var{line} @dots{}\n\
640 @deftypefnx {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\")\n\
637 @deftypefnx {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\", @var{line})\n\ 641 @deftypefnx {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\", @var{line})\n\
638 @deftypefnx {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\", @var{line1}, @var{line2}, @dots{})\n\ 642 @deftypefnx {Built-in Function} {@var{rline} =} dbstop (\"@var{func}\", @var{line1}, @var{line2}, @dots{})\n\
639 Set a breakpoint in function @var{func}.\n\ 643 @deftypefnx {Built-in Function} {} dbstop (\"@var{func}\", [@var{line1}, @dots{}])\n\
644 @deftypefnx {Built-in Function} {} dbstop (@var{line}, @dots{})\n\
645 Set a breakpoint at line number @var{line} in function @var{func}.\n\
640 \n\ 646 \n\
641 Arguments are\n\ 647 Arguments are\n\
642 \n\ 648 \n\
643 @table @var\n\ 649 @table @var\n\
644 @item func\n\ 650 @item func\n\
645 Function name as a string variable. When already in debug\n\ 651 Function name as a string variable. When already in debug mode this argument\n\
646 mode this should be left out and only the line should be given.\n\ 652 can be omitted and the current function will be used.\n\
647 \n\ 653 \n\
648 @item line\n\ 654 @item line\n\
649 Line number where the breakpoint should be set. Multiple\n\ 655 Line number where the breakpoint should be set. Multiple lines may be given\n\
650 lines may be given as separate arguments or as a vector.\n\ 656 as separate arguments or as a vector.\n\
651 @end table\n\ 657 @end table\n\
652 \n\ 658 \n\
653 When called with a single argument @var{func}, the breakpoint\n\ 659 When called with a single argument @var{func}, the breakpoint is set at the\n\
654 is set at the first executable line in the named function.\n\ 660 first executable line in the named function.\n\
655 \n\ 661 \n\
656 The optional output @var{rline} is the real line number where the\n\ 662 The optional output @var{rline} is the real line number where the breakpoint\n\
657 breakpoint was set. This can differ from specified line if\n\ 663 was set. This can differ from the specified line if the line is not\n\
658 the line is not executable. For example, if a breakpoint attempted on a\n\ 664 executable. For example, if a breakpoint attempted on a blank line then\n\
659 blank line then Octave will set the real breakpoint at the\n\ 665 Octave will set the real breakpoint at the next executable line.\n\
660 next executable line.\n\
661 @seealso{dbclear, dbstatus, dbstep, debug_on_error, debug_on_warning, debug_on_interrupt}\n\ 666 @seealso{dbclear, dbstatus, dbstep, debug_on_error, debug_on_warning, debug_on_interrupt}\n\
662 @end deftypefn") 667 @end deftypefn")
663 { 668 {
664 bp_table::intmap retval; 669 bp_table::intmap retval;
665 std::string symbol_name; 670 std::string symbol_name;
1349 } 1354 }
1350 } 1355 }
1351 1356
1352 DEFUN (dbup, args, , 1357 DEFUN (dbup, args, ,
1353 "-*- texinfo -*-\n\ 1358 "-*- texinfo -*-\n\
1354 @deftypefn {Built-in Function} {} dbup\n\ 1359 @deftypefn {Command} {} dbup\n\
1355 @deftypefnx {Built-in Function} {} dbup (@var{n})\n\ 1360 @deftypefnx {Command} {} dbup @var{n}\n\
1356 In debugging mode, move up the execution stack @var{n} frames.\n\ 1361 In debugging mode, move up the execution stack @var{n} frames.\n\
1357 If @var{n} is omitted, move up one frame.\n\ 1362 If @var{n} is omitted, move up one frame.\n\
1358 @seealso{dbstack, dbdown}\n\ 1363 @seealso{dbstack, dbdown}\n\
1359 @end deftypefn") 1364 @end deftypefn")
1360 { 1365 {
1365 return retval; 1370 return retval;
1366 } 1371 }
1367 1372
1368 DEFUN (dbdown, args, , 1373 DEFUN (dbdown, args, ,
1369 "-*- texinfo -*-\n\ 1374 "-*- texinfo -*-\n\
1370 @deftypefn {Built-in Function} {} dbdown\n\ 1375 @deftypefn {Command} {} dbdown\n\
1371 @deftypefnx {Built-in Function} {} dbdown (@var{n})\n\ 1376 @deftypefnx {Command} {} dbdown @var{n}\n\
1372 In debugging mode, move down the execution stack @var{n} frames.\n\ 1377 In debugging mode, move down the execution stack @var{n} frames.\n\
1373 If @var{n} is omitted, move down one frame.\n\ 1378 If @var{n} is omitted, move down one frame.\n\
1374 @seealso{dbstack, dbup}\n\ 1379 @seealso{dbstack, dbup}\n\
1375 @end deftypefn") 1380 @end deftypefn")
1376 { 1381 {