Mercurial > octave
changeset 32396:fc3f9660d5f2
doc: Remove "Internal function" from VM function descriptions
author | Arun Giridhar <arungiridhar@gmail.com> |
---|---|
date | Sun, 08 Oct 2023 15:17:47 -0400 |
parents | d738b7d335b5 |
children | 9281146e836b |
files | libinterp/corefcn/compile.cc scripts/help/vm.m |
diffstat | 2 files changed, 7 insertions(+), 21 deletions(-) [+] |
line wrap: on
line diff
--- a/libinterp/corefcn/compile.cc Sun Oct 08 15:12:10 2023 -0400 +++ b/libinterp/corefcn/compile.cc Sun Oct 08 15:17:47 2023 -0400 @@ -85,7 +85,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{val} =} vm_clear_cache () -Internal function. +Clear the VM evaluator's internal cache. @end deftypefn */) { @@ -98,8 +98,6 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{prints_trace} =} vm_print_trace ()) -Internal function. - Print a debug trace from the VM. Toggles on or off each call. There has to be a breakpoint set in some file for the trace @@ -118,8 +116,6 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{count} =} __ref_count__ (@var{obj})) -Internal function. - Returns reference count for an object. @end deftypefn */) @@ -138,8 +134,6 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{is_executing} =} vm_is_executing ()) -Internal function. - Returns true if the VM is executing the function calling vm_is_executing (). False otherwise. @@ -168,8 +162,6 @@ @deftypefnx {} {@var{T} =} vm_profile ("info") @deftypefnx {} {} vm_profile -Internal function. - Profile code running in the VM. @table @code @@ -277,8 +269,6 @@ @deftypefn {} {@var{success} =} vm_print_bytecode (@var{fn_name})) @deftypefnx {} {@var{success} =} vm_print_bytecode (@var{fn_handle})) -Internal function. - Prints the bytecode of a function name or function handle, if any. @end deftypefn */) @@ -352,8 +342,6 @@ @deftypefn {} {@var{is_compiled} =} vm_is_compiled (@var{fn_name}) @deftypefnx {} {@var{is_compiled} =} vm_is_compiled (@var{fn_handle}) -Internal function. - Returns true if the specified function name or function handle is compiled. False otherwise. @@ -417,8 +405,6 @@ @deftypefnx {} {@var{success} =} vm_compile (@var{fn_name}, "clear") @deftypefnx {} {@var{success} =} vm_compile (@var{fn_name}, "print") -Internal function. - Compile the specified function to bytecode. The compiled function and its subfunctions will be executed
--- a/scripts/help/vm.m Sun Oct 08 15:12:10 2023 -0400 +++ b/scripts/help/vm.m Sun Oct 08 15:17:47 2023 -0400 @@ -40,22 +40,22 @@ ## VM user function. Compile a specified function to bytecode. ## ## @item vm_clear_cache -## Internal function. Clear the cache of already-processed code. +## Clear the cache of already-processed code. ## ## @item vm_is_compiled -## VM internal function. Return true if the specified function is compiled. +## Return true if the specified function is compiled. ## ## @item vm_is_executing -## Internal function. Return true if the VM is executing. +## Return true if the VM is executing. ## ## @item vm_print_bytecode -## Internal function. Print bytecode of specified function. +## Print bytecode of specified function. ## ## @item vm_print_trace -## Internal function. Print a debug trace from the VM. +## Print a debug trace from the VM. ## ## @item vm_profile -## Internal function. Profile the code running in the VM. +## Profile the code running in the VM. ## ## @end table ##