Skip to content

Commit

Permalink
doc: Remove "Internal function" from VM function descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
arungiridhar committed Oct 8, 2023
1 parent e7094a1 commit 751cfff
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 21 deletions.
16 changes: 1 addition & 15 deletions libinterp/corefcn/compile.cc
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ DEFUN (vm_clear_cache, , ,
doc: /* -*- texinfo -*-
@deftypefn {} {@var{val} =} vm_clear_cache ()
Internal function.
Clear the VM evaluator's internal cache.
@end deftypefn */)
{
Expand All @@ -98,8 +98,6 @@ DEFUN (vm_print_trace, , ,
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
Expand All @@ -118,8 +116,6 @@ DEFUN (__ref_count__, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {@var{count} =} __ref_count__ (@var{obj}))
Internal function.
Returns reference count for an object.
@end deftypefn */)
Expand All @@ -138,8 +134,6 @@ DEFMETHOD (vm_is_executing, interp, , ,
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.
Expand Down Expand Up @@ -168,8 +162,6 @@ DEFMETHOD (vm_profile, interp, args, ,
@deftypefnx {} {@var{T} =} vm_profile ("info")
@deftypefnx {} {} vm_profile
Internal function.
Profile code running in the VM.
@table @code
Expand Down Expand Up @@ -277,8 +269,6 @@ DEFMETHOD (vm_print_bytecode, interp, args, ,
@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 */)
Expand Down Expand Up @@ -352,8 +342,6 @@ DEFMETHOD (vm_is_compiled, interp, args, ,
@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.
Expand Down Expand Up @@ -417,8 +405,6 @@ DEFMETHOD (vm_compile, interp, args, ,
@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
Expand Down
12 changes: 6 additions & 6 deletions scripts/help/vm.m
Original file line number Diff line number Diff line change
Expand Up @@ -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
##
Expand Down

0 comments on commit 751cfff

Please sign in to comment.