Mercurial > octave-antonio
view libinterp/mkbuiltins @ 20162:2645f9ef8c88 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed specfun, special-matrix, testfun, and time script directories.
* scripts/specfun/expint.m, scripts/specfun/isprime.m,
scripts/specfun/legendre.m, scripts/specfun/primes.m,
scripts/specfun/reallog.m, scripts/specfun/realsqrt.m,
scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m,
scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m,
scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m,
scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m,
scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m,
scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m,
scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m,
scripts/testfun/rundemos.m, scripts/testfun/runtests.m,
scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m,
scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m,
scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m,
scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 17:00:11 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
#! /bin/sh # # Copyright (C) 1996-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 test $# -lt 2; then echo "usage: mkbuiltins --header|--source f1 f2 ..." 1>&2 exit 1 fi SED=${SED:-'sed'} make_header=false make_source=false case "$1" in --header) make_header=true shift ;; --source) make_source=true shift ;; *) echo "mkbuiltins: unrecognized option: $1" 1>&2 exit 1 ;; esac if $make_header; then cat << \EOF // DO NOT EDIT! Generated automatically by mkbuiltins. #if !defined (octave_builtin_defun_decls_h) #define octave_builtin_defun_decls_h 1 #include "oct-obj.h" #define DEFUN_DECL(name) \ extern OCTINTERP_API octave_value_list \ name (const octave_value_list& = octave_value_list (), int = 0); EOF $SED -n -e 's/ *\(XDEFUN\|XDEFCONSTFUN\)_INTERNAL *( *\([_A-Za-z][_A-Za-z0-9]*\) *,.*$/DEFUN_DECL (F\2);/p; s/^ *XDEFUNX_INTERNAL *( *"\([_A-Za-z][_A-Za-z0-9]*\)" *,.*$/DEFUN_DECL (F\1);/p' "$@" cat << \EOF #undef DEFUN_DECL #endif EOF else cat << \EOF // DO NOT EDIT! Generated automatically by mkbuiltins. #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "defun.h" #include "help.h" #include "oct-obj.h" #include "variables.h" #include "builtins.h" #if defined (quad) #undef quad #endif #if defined (ENABLE_DYNAMIC_LINKING) #define XDEFUN_DLD_INTERNAL(name, args_name, nargout_name, doc) #define XDEFUNX_DLD_INTERNAL(name, fname, args_name, nargout_name, doc) #else #define XDEFUN_DLD_INTERNAL(name, args_name, nargout_name, doc) \ XDEFUN_INTERNAL(name, args_name, nargout_name, doc) #define XDEFUNX_DLD_INTERNAL(name, fname, args_name, nargout_name, doc) \ XDEFUNX_INTERNAL(name, fname, args_name, nargout_name, doc) #endif #define XDEFUN_FILE_NAME(name) \ std::string file = name; #define XDEFUN_INTERNAL(name, args_name, nargout_name, doc) \ extern DECLARE_FUN (name, args_name, nargout_name); \ install_builtin_function (F ## name, #name, file, doc); \ #define XDEFCONSTFUN_INTERNAL(name, args_name, nargout_name, doc) \ extern DECLARE_FUN (name, args_name, nargout_name); \ install_builtin_function (F ## name, #name, file, doc, false); \ #define XDEFUNX_INTERNAL(name, fname, args_name, nargout_name, doc) \ extern DECLARE_FUNX (fname, args_name, nargout_name); \ install_builtin_function (fname, name, file, doc); \ #define XDEFALIAS_INTERNAL(alias, name) \ alias_builtin (#alias, #name); #define XDEFCONST_INTERNAL(name, defn, doc) EOF for arg do fcn=`echo "$arg" | $SED 's,.*/,,; s/\.df//; s/-/_/g;'` echo "static void" echo "install_${fcn}_fcns (void)" echo "{" cat "$arg" echo "}" echo "" done cat << \EOF void install_builtins (void) { EOF for arg do fcn=`echo "$arg" | $SED 's,.*/,,; s/\.df//; s/-/_/g;'` echo " install_${fcn}_fcns ();" done cat << \EOF install_built_in_docstrings (); } EOF fi exit 0