comparison libinterp/interp-core/pt-jit.cc @ 15539:4d6e5fa37899

doc: Update docstrings for enable_jit_debugging and enable_jit_compiler. * pt-jit.cc(Fenable_jit_debugging, Fenable_jit_compiler): Add alternate calling forms of function. Add seealso links. Add documentation about "local" option.
author Rik <rik@octave.org>
date Wed, 17 Oct 2012 08:57:42 -0700
parents 29382eb90285
children 52df2e7baabe
comparison
equal deleted inserted replaced
15538:94d21131fefd 15539:4d6e5fa37899
2180 2180
2181 #endif 2181 #endif
2182 2182
2183 DEFUN (enable_jit_debugging, args, nargout, 2183 DEFUN (enable_jit_debugging, args, nargout,
2184 "-*- texinfo -*-\n\ 2184 "-*- texinfo -*-\n\
2185 @deftypefn {Built-in Function} {} enable_jit_debugging ()\n\ 2185 @deftypefn {Built-in Function} {@var{val} =} enable_jit_debugging ()\n\
2186 @deftypefnx {Built-in Function} {@var{old_val} =} enable_jit_debugging (@var{new_val})\n\
2187 @deftypefnx {Built-in Function} {} enable_jit_debugging (@var{new_val}, \"local\")\n\
2186 Query or set the internal variable that determines whether\n\ 2188 Query or set the internal variable that determines whether\n\
2187 debugging/tracing is enabled for Octave's JIT compiler.\n\ 2189 debugging/tracing is enabled for Octave's JIT compiler.\n\
2190 \n\
2191 When called from inside a function with the \"local\" option, the variable is\n\
2192 changed locally for the function and any subroutines it calls. The original\n\
2193 variable value is restored when exiting the function.\n\
2194 @seealso{enable_jit_compiler}\n\
2188 @end deftypefn") 2195 @end deftypefn")
2189 { 2196 {
2190 #if defined (HAVE_LLVM) 2197 #if defined (HAVE_LLVM)
2191 return SET_INTERNAL_VARIABLE (enable_jit_debugging); 2198 return SET_INTERNAL_VARIABLE (enable_jit_debugging);
2192 #else 2199 #else
2195 #endif 2202 #endif
2196 } 2203 }
2197 2204
2198 DEFUN (enable_jit_compiler, args, nargout, 2205 DEFUN (enable_jit_compiler, args, nargout,
2199 "-*- texinfo -*-\n\ 2206 "-*- texinfo -*-\n\
2200 @deftypefn {Built-in Function} {} enable_jit_compiler ()\n\ 2207 @deftypefn {Built-in Function} {@var{val} =} enable_jit_compiler ()\n\
2208 @deftypefnx {Built-in Function} {@var{old_val} =} enable_jit_compiler (@var{new_val})\n\
2209 @deftypefnx {Built-in Function} {} enable_jit_compiler (@var{new_val}, \"local\")\n\
2201 Query or set the internal variable that enables Octave's JIT compiler.\n\ 2210 Query or set the internal variable that enables Octave's JIT compiler.\n\
2211 \n\
2212 When called from inside a function with the \"local\" option, the variable is\n\
2213 changed locally for the function and any subroutines it calls. The original\n\
2214 variable value is restored when exiting the function.\n\
2215 @seealso{enable_jit_debugging}\n\
2202 @end deftypefn") 2216 @end deftypefn")
2203 { 2217 {
2204 #if defined (HAVE_LLVM) 2218 #if defined (HAVE_LLVM)
2205 return SET_INTERNAL_VARIABLE (enable_jit_compiler); 2219 return SET_INTERNAL_VARIABLE (enable_jit_compiler);
2206 #else 2220 #else