view scripts/mkdoc @ 14872:c2dbdeaa25df

maint: use rows() and columns() to clarify m-files. * gradient.m, interp1q.m, rat.m, tsearchn.m, image.m, imwrite.m, area.m, contourc.m, hist.m, isocolors.m, isonormals.m, meshz.m, print.m, __bar__.m, __go_draw_axes__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m, __print_parse_opts__.m, __quiver__.m, rose.m, shrinkfaces.m, stairs.m, surfnorm.m, tetramesh.m, text.m, deconv.m, spline.m, intersect.m, setdiff.m, setxor.m, union.m, periodogram.m, pcg.m, perms.m: Replace size (x,1) with rows (x) and size(x,2) with columns(x).
author Rik <octave@nomad.inbox5.com>
date Tue, 17 Jul 2012 13:34:19 -0700
parents 72c96de7a403
children d63878346099
line wrap: on
line source

#! /bin/sh
#
# Copyright (C) 1999-2012 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/>.

## Expecting arguments in this order:
##
##  SRCDIR SRCDIR-FILES ... -- LOCAL-FILES ...

set -e

PERL=${PERL:-'perl'}

prefix="$1/"
shift

if test -f gethelp; then
  cat << EOF
### DO NOT EDIT!
###
### This file is generated automatically from the Octave sources.
### Edit those files instead and run make to update this file.

EOF
  for arg
  do
    if [ "$arg" = "--" ]; then
      prefix="./"
    else
      $PERL -w -e '
        unless (@ARGV == 2) { die "Usage: $0 srcdir m_filename" ; }
        ($srcdir, $m_fname) = ($ARGV[0], $ARGV[1]);
        $full_fname = $srcdir . $m_fname;
        exit unless ( $full_fname =~ m{(.*)/(@|)([^/]*)/(.*)\.m} );
        if ($2) {
          $fcn = "$2$3/$4";
        } else {
          $fcn = $4;
        }
        $re_srcdir = quotemeta($srcdir);
        for (qx{ ./gethelp $fcn "$full_fname" < "$full_fname"} ) {
          s/^\s+\@/\@/ unless $in_example;
          s/^\s+\@group/\@group/;
          s/^\s+\@end\s+group/\@end group/;
          s|\@c $fcn $re_srcdir|\@c $fcn scripts/|o;
          $in_example = (/\s*\@example\b/ .. /\s*\@end\s+example\b/);
          print;
        }' "$prefix" "$arg"
    fi
  done
else
  echo "gethelp program seems to be missing!" 1>&2
  exit 1
fi