Mercurial > hg > octave-nkf
changeset 18285:bffa6c8255a9
doc: Rewrite docstring for filemarker.
* input.cc (Ffilemarker): Rewrite docstring.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 11 Jan 2014 22:50:11 -0800 |
parents | c6858f725afe |
children | 69990d5edcc2 |
files | libinterp/corefcn/input.cc |
diffstat | 1 files changed, 10 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/input.cc +++ b/libinterp/corefcn/input.cc @@ -1406,11 +1406,12 @@ DEFUN (filemarker, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} filemarker ()\n\ -@deftypefnx {Built-in Function} {} filemarker (@var{new_val})\n\ +@deftypefnx {Built-in Function} {@var{old_val} =} filemarker (@var{new_val})\n\ @deftypefnx {Built-in Function} {} filemarker (@var{new_val}, \"local\")\n\ -Query or set the character used to separate filename from the\n\ -the subfunction names contained within the file. This can be used in\n\ -a generic manner to interact with subfunctions. For example,\n\ +Query or set the character used to separate the filename from the subfunction\n\ +names contained within the file. By default this is the character @samp{>}.\n\ +This can be used in a generic manner to interact with subfunctions.\n\ +For example,\n\ \n\ @example\n\ help ([\"myfunc\", filemarker, \"mysubfunc\"])\n\ @@ -1418,8 +1419,10 @@ \n\ @noindent\n\ returns the help string associated with the subfunction @code{mysubfunc}\n\ -of the function @code{myfunc}. Another use of @code{filemarker} is when\n\ -debugging it allows easier placement of breakpoints within subfunctions.\n\ +located in the file @file{myfunc.m}.\n\ +\n\ +@code{filemarker} is also useful during debugging for placing breakpoints\n\ +within subfunctions or nested functions.\n\ For example,\n\ \n\ @example\n\ @@ -1430,7 +1433,7 @@ will set a breakpoint at the first line of the subfunction @code{mysubfunc}.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ -variable is changed locally for the function and any subroutines it calls. \n\ +variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @end deftypefn") {