Mercurial > octave-antonio
view scripts/miscellaneous/debug.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2008-2015 David Bateman ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} debug () ## Summary of debugging commands. ## ## For more information on each command and available options use ## @code{help CMD}. ## ## The debugging commands available in Octave are ## ## @table @code ## @item dbstop ## Add a breakpoint. ## ## @item dbclear ## Remove a breakpoint. ## ## @item dbstatus ## List all breakpoints. ## ## @item dbwhere ## Report the current file and line number where execution is stopped. ## ## @item dbtype ## Display the code of the function being debugged, enumerating ## the line numbers. ## ## @item dblist ## List 10 lines of code centered around the line number where execution is ## stopped. ## ## @item dbstep ## @itemx dbnext ## Execute (step) one or more lines, follow execution into (step into) a ## function call, or execute until the end of a function (step out), and ## re-enter debug mode. ## ## @item dbcont ## Continue normal code execution from the debug prompt. ## ## @item dbquit ## Quit debugging mode immediately and return to the main prompt. ## ## @item dbstack ## Print a backtrace of the execution stack. ## ## @item dbup ## Move up the execution stack. ## ## @item dbdown ## Move down the execution stack. ## ## @item keyboard ## Force entry into debug mode from an m-file. ## ## @item debug_on_error ## Configure whether Octave enters debug mode when it encounters an error. ## ## @item debug_on_warning ## Configure whether Octave enters debug mode when it encounters a warning. ## ## @item debug_on_interrupt ## Configure whether Octave enters debug mode when it encounters an interrupt. ## ## @item isdebugmode ## Return true if in debug mode. ## @end table ## ## @noindent ## When Octave encounters a breakpoint, or other reason to enter debug mode, ## the prompt changes to @qcode{"debug>"}. The workspace of the function ## where the breakpoint was encountered becomes available and any Octave ## command that is valid in that workspace context may be executed. ## ## @seealso{dbstop, dbclear, dbstatus, dbwhere, dbtype, dbcont, dbquit, ## dbstack, dbup, dbdown, keyboard, debug_on_error, debug_on_warning, ## debug_on_interrupt, isdebugmode} ## @end deftypefn function debug () help ("debug"); endfunction ## Mark file as being tested. No real test needed for a documentation .m file %!assert (1)