Mercurial > octave-nkf
view scripts/mkdoc.pl @ 20263:00cf2847355d
Deprecate Array::nelem() and Range::nelem() in favour of ::numel().
* liboctave/array/Array.h (Array::nelem) deprecate in favour of numel().
(Array::capacity, Array:: length): change to call numel() directly. These
methods will be deprecated soon.
* liboctave/array/PermMatrix.h (PermMatrix::nelem): deprecate in favour of
numel().
* liboctave/array/Range.h (Range::numel) new method to replace nelem().
(Range::nelem) deprecate in favour of the new method numel.
* liboctave/array/Sparse.h (Sparse::nelem) deprecate in favour of nzmax().
This one is secially bad because unlike the other classes, it is different
from numel().
* libinterp/corefcn/debug.cc, libinterp/corefcn/jit-typeinfo.cc,
libinterp/corefcn/ls-mat4.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/max.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/xpow.cc, libinterp/dldfcn/__magick_read__.cc,
libinterp/dldfcn/audioread.cc, libinterp/octave-value/ov-base-int.cc,
libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-flt-re-mat.cc,
libinterp/octave-value/ov-perm.cc, libinterp/octave-value/ov-range.cc,
libinterp/octave-value/ov-range.h, libinterp/octave-value/ov-re-mat.cc,
libinterp/parse-tree/pt-eval.cc, liboctave/array/Array.cc,
liboctave/array/CNDArray.cc, liboctave/array/Range.cc,
liboctave/array/dNDArray.cc, liboctave/array/fCNDArray.cc,
liboctave/array/fNDArray.cc, liboctave/array/idx-vector.cc,
liboctave/array/intNDArray.cc, liboctave/numeric/SparseCmplxLU.cc,
liboctave/numeric/SparsedbleLU.cc: replace use of nelem() with numel().
author | Carnë Draug <carandraug@octave.org> |
---|---|
date | Sun, 24 May 2015 02:41:37 +0100 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
#! /usr/bin/perl use utf8; # Copyright (C) 2012-2015 Rik Wehbring # # 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/>. use strict; use warnings; use File::Spec; use Cwd; ## Expecting arguments in this order: ## ## SRCDIR SRCDIR-FILES ... -- LOCAL-FILES ... unless (@ARGV >= 2) { die "Usage: $0 srcdir m_filename1 ..." ; } my $srcdir = shift (@ARGV); print <<__END_OF_MSG__; ### DO NOT EDIT! ### ### This file is generated automatically from Octave source files. ### Edit source files directly and run make to update this file. __END_OF_MSG__ MFILE: foreach my $m_fname (@ARGV) { if ($m_fname eq "--") { $srcdir = getcwd (); next MFILE; } my $full_fname = File::Spec->catfile ($srcdir, $m_fname); my @paths = File::Spec->splitdir ($full_fname); if (@paths < 3 || $paths[-2] eq "private" # skip private directories || $paths[-1] !~ s/\.m$//i) # skip non m-files, and remove extension { next MFILE; } ## @classes will have @class/method as their function name my $fcn = $paths[-2] =~ m/^@/ ? File::Spec->catfile (@paths[-2, -1]) : $paths[-1]; my @help_txt = gethelp ($fcn, $full_fname); next MFILE unless @help_txt; print "\x{1d}$fcn\n"; print "\@c $fcn ", File::Spec->catfile ("scripts", $m_fname), "\n"; foreach $_ (@help_txt) { my $in_example = (m/\s*\@example\b/ .. m/\s*\@end\s+example\b/); s/^\s+\@/\@/ unless $in_example; s/^\s+(\@(?:end)\s+(group|example))/$1/; print $_; } } ################################################################################ # Subroutines ################################################################################ sub gethelp { my $fcn = shift; my $fname = shift; open (my $fh, "<", $fname) or return; my @help_txt; while (my $line = <$fh>) { next if $line =~ m/^\s*$/; # skip empty lines last if $line !~ m/^\s*(#|%)/; # out of here once code starts my $reading_block = sub {defined ($line = <$fh>) && $line !~ m/^\s*$/}; ## Skip this block if ($line =~ /(Copyright|Author)/) { while (&$reading_block ()) {} } else { do { $line =~ s/^\s*(%|#)+ ?//; push (@help_txt, $line); } while (&$reading_block ()); last; } } close ($fh); return @help_txt; }