Mercurial > octave
view libinterp/corefcn/defun.h @ 20946:6eff66fb8a02
style fixes for comments
* find-dialog.cc, find-dialog.h, display.cc, error.cc, gl-render.cc,
graphics.cc, graphics.in.h, max.cc, oct-handle.h, oct-obj.h,
oct-stream.cc, oct.h, pr-output.cc, profiler.cc, str2double.cc,
symtab.cc, toplev.cc, toplev.h, xgl2ps.c, zfstream.cc, zfstream.h,
__glpk__.cc, audiodevinfo.cc, colamd.cc, symbfact.cc, ov-classdef.cc,
ov-classdef.h, ov-java.cc, op-int.h, pt-pr-code.cc, pt-walk.h:
Use C++-style comments where possible.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 18 Dec 2015 22:39:36 -0500 |
parents | f7084eae3318 |
children | fcac5dbbf9ed |
line wrap: on
line source
/* Copyright (C) 1994-2015 John W. Eaton This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #if ! defined (octave_defun_h) #define octave_defun_h 1 #if defined (octave_defun_dld_h) #error defun.h and defun-dld.h both included in same file! #endif #include "defun-int.h" // Define a builtin function. // // name is the name of the function, unqouted. // // args_name is the name of the octave_value_list variable used to pass // the argument list to this function. // // nargout_name is the name of the int variable used to pass the // number of output arguments this function is expected to produce. // // doc is the simple help text for the function. #define DEFUN(name, args_name, nargout_name, doc) \ DEFUN_INTERNAL (name, args_name, nargout_name, doc) // This one can be used when 'name' cannot be used directly (if it is // already defined as a macro). In that case, name is already a // quoted string, and the internal name of the function must be passed // too (the convention is to use a prefix of "F", so "foo" becomes "Ffoo"). #define DEFUNX(name, fname, args_name, nargout_name, doc) \ DEFUNX_INTERNAL (name, fname, args_name, nargout_name, doc) // This is a function with a name that can't be hidden by a variable. #define DEFCONSTFUN(name, args_name, nargout_name, doc) \ DEFCONSTFUN_INTERNAL (name, args_name, nargout_name, doc) // Make alias another name for the existing function name. This macro // must be used in the same file where name is defined, after the // definition for name. #define DEFALIAS(alias, name) \ DEFALIAS_INTERNAL (alias, name) #endif