comparison pyexec.cc @ 173:28dc607532c2

doc: Clarify and clean up docstrings for all oct files * pycall.cc, pyeval.cc, pyexec.cc: Reword summary to clarify differences between the functions. Use Octave docstring style. Add @example and @seealso sections.
author Mike Miller <mtmiller@octave.org>
date Thu, 07 Apr 2016 15:26:53 -0700
parents df7b4a5ab542
children 382bb1d91239 6fffa6219b2c
comparison
equal deleted inserted replaced
172:29d9da90afcf 173:28dc607532c2
37 37
38 using namespace boost::python; 38 using namespace boost::python;
39 39
40 DEFUN_DLD (pyexec, args, nargout, 40 DEFUN_DLD (pyexec, args, nargout,
41 "-*- texinfo -*-\n\ 41 "-*- texinfo -*-\n\
42 @deftypefn {Loadable Function} pyexec (@var{func})\n\ 42 @deftypefn {} {} pyexec (@var{expr})\n\
43 Execute some python code.\n\ 43 Execute a Python expression or block of code.\n\
44 \n\
45 Examples:\n\
46 @example\n\
47 @group\n\
48 pyexec (\"print(42)\")\n\
49 @print{} 42\n\
50 @end group\n\
51 @end example\n\
52 @seealso{pycall, pyeval}\n\
44 @end deftypefn") 53 @end deftypefn")
45 { 54 {
46 octave_value_list retval; 55 octave_value_list retval;
47 56
48 int nargin = args.length (); 57 int nargin = args.length ();