Mercurial > jwe > octave
changeset 20469:33b03b06442b
doc: Add a docstring for __current_scope__.
* symtab.cc (__current_scope__, __dump_symtab_info__): Add docstring for
__current_scope__. Add seealso link to __current_scope__ from
__dump_symtab_info__.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 29 Aug 2015 05:59:45 -0700 |
parents | 2f94652de9ff |
children | 784ed55fdde8 |
files | libinterp/corefcn/symtab.cc |
diffstat | 1 files changed, 4 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/symtab.cc Thu Aug 27 15:52:06 2015 -0700 +++ b/libinterp/corefcn/symtab.cc Sat Aug 29 05:59:45 2015 -0700 @@ -1729,8 +1729,9 @@ DEFUN (__current_scope__, , , "-*- texinfo -*-\n\ -@deftypefn {Built-in Function} {[@var{scope}, @var{context}]} __dump_symtab_info__ ()\n\ -Undocumented internal function.\n\ +@deftypefn {Built-in Function} {[@var{scope}, @var{context}]} __current_scope__ ()\n\ +Return the current scope and context as integers.\n\ +@seealso{__dump_symtab_info__}\n\ @end deftypefn") { octave_value_list retval; @@ -1748,6 +1749,7 @@ @deftypefnx {Built-in Function} {} __dump_symtab_info__ (\"scopes\")\n\ @deftypefnx {Built-in Function} {} __dump_symtab_info__ (\"functions\")\n\ Undocumented internal function.\n\ +@seealso{__current_scope__}\n\ @end deftypefn") { octave_value retval;