Mercurial > octave
comparison libinterp/parse-tree/oct-parse.in.yy @ 24624:ce2eb28e0a6d
doc: make all Doxygen comment blocks more consistent
* Array.h, dim-vector.h, gzip.cc, octave-link.h, octave-qt-link.h,
oct-parse.in.yy, oct-string.h, ov-base.h, ov.h, ovl.h, str-vec.h: Use uniform
C++ block commenting style consistent with the rest of Octave. Don't use
unnecessary @brief or @class markers. Use @-style commands instead of \-style.
| author | Mike Miller <mtmiller@octave.org> |
|---|---|
| date | Fri, 19 Jan 2018 19:59:28 -0800 |
| parents | 194eb4bd202b |
| children | 8b346a19108e |
comparison
equal
deleted
inserted
replaced
| 24623:f39ae754a7d8 | 24624:ce2eb28e0a6d |
|---|---|
| 5175 return retval; | 5175 return retval; |
| 5176 } | 5176 } |
| 5177 | 5177 |
| 5178 namespace octave | 5178 namespace octave |
| 5179 { | 5179 { |
| 5180 /*! | 5180 //! Evaluate an Octave function (built-in or interpreted) and return |
| 5181 Evaluate an Octave function (built-in or interpreted) and return | 5181 //! the list of result values. |
| 5182 the list of result values. | 5182 //! |
| 5183 | 5183 //! @param name The name of the function to call. |
| 5184 @param name The name of the function to call. | 5184 //! @param args The arguments to the function. |
| 5185 @param args The arguments to the function. | 5185 //! @param nargout The number of output arguments expected. |
| 5186 @param nargout The number of output arguments expected. | 5186 //! @return A list of output values. The length of the list is not |
| 5187 @return A list of output values. The length of the list is not | 5187 //! necessarily the same as @c nargout. |
| 5188 necessarily the same as @c nargout. | 5188 |
| 5189 | |
| 5190 */ | |
| 5191 octave_value_list | 5189 octave_value_list |
| 5192 feval (const std::string& name, const octave_value_list& args, int nargout) | 5190 feval (const std::string& name, const octave_value_list& args, int nargout) |
| 5193 { | 5191 { |
| 5194 octave_value_list retval; | 5192 octave_value_list retval; |
| 5195 | 5193 |
| 5260 return args.slice (1, args.length () - 1, true); | 5258 return args.slice (1, args.length () - 1, true); |
| 5261 } | 5259 } |
| 5262 | 5260 |
| 5263 namespace octave | 5261 namespace octave |
| 5264 { | 5262 { |
| 5265 /*! | 5263 //! Evaluate an Octave function (built-in or interpreted) and return |
| 5266 Evaluate an Octave function (built-in or interpreted) and return | 5264 //! the list of result values. |
| 5267 the list of result values. | 5265 //! |
| 5268 | 5266 //! @param args The first element of @c args is the function to call. |
| 5269 @param args The first element of @c args is the function to call. | 5267 //! It may be the name of the function as a string, a function |
| 5270 It may be the name of the function as a string, a function | 5268 //! handle, or an inline function. The remaining arguments are |
| 5271 handle, or an inline function. The remaining arguments are | 5269 //! passed to the function. |
| 5272 passed to the function. | 5270 //! @param nargout The number of output arguments expected. |
| 5273 @param nargout The number of output arguments expected. | 5271 //! @return A list of output values. The length of the list is not |
| 5274 @return A list of output values. The length of the list is not | 5272 //! necessarily the same as @c nargout. |
| 5275 necessarily the same as @c nargout. | 5273 |
| 5276 */ | |
| 5277 octave_value_list | 5274 octave_value_list |
| 5278 feval (const octave_value_list& args, int nargout) | 5275 feval (const octave_value_list& args, int nargout) |
| 5279 { | 5276 { |
| 5280 if (args.length () > 0) | 5277 if (args.length () > 0) |
| 5281 { | 5278 { |