Mercurial > octave
view scripts/mk-doc.pl @ 30998:1bf26f913b9c
std.m, var.m: Cleanup functions.
* std.m: Re-write documentation to be in present tense per Octave convention.
Use lowercase for "all" parameter. Use Texinfo @. to end sentence ending with
capital N. Check for zero arguments to function and call print_usage().
Remove BIST tests for empty inputs and bug #62395 which are simply duplicating
tests in var.m. Remove input validation tests which are duplicating tests in
var.m.
* var.m: Re-write documentation to be in present tense per Octave convention.
Use lowercase for "all" parameter. Use Texinfo @. to end sentence ending with
capital N. Use default in function prototype for third input "dim" to eliminate
elseif branch in input validation. Put input validation as close to top of
function as possible. Rename "highest_dim" to "max_dim" for clarity & brevity.
Rename "ALL" to "all" in error() statements. Replace "strcmp (tolower (...))"
with strcmpi. Avoid slow call to isequal().
author | Rik <rik@octave.org> |
---|---|
date | Sat, 14 May 2022 18:03:35 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
#! /usr/bin/perl use utf8; ######################################################################## ## ## Copyright (C) 2012-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## use strict; use warnings; use File::Spec; use Cwd; ## Expecting arguments in this order: ## ## SRCDIR SRCDIR-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) { 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/(\.in|)\.m$//i) # skip non m-files, and remove extension { next MFILE; } my $fcn; if ($paths[-2] =~ m/^@/) { ## @classes will have @class/method as their function name $fcn = File::Spec->catfile (@paths[-2, -1]); } elsif ($paths[-2] =~ m/^\+/) { $fcn = $paths[-1]; for (my $i = 2; $i < @paths; $i++) { if ($paths[-$i] =~ m/^\+/) { ## +package functions have package.name their function name $fcn = substr ($paths[-$i], 1) . "." . $fcn; } } } else { $fcn = $paths[-1]; } my @help_txt = gethelp ($fcn, $full_fname); next MFILE unless @help_txt; print "\x{1d}$fcn\n"; print "\@c $fcn $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; my $have_cdef_file = 0; my $found_code = 0; open (my $fh, "<", $fname) or return; my @help_txt; while (my $line = <$fh>) { next if $line =~ m/^[\s#%]*$/; # skip empty lines if ($line !~ m/^\s*(#|%)/) { if (! $found_code) { $found_code = 1; $have_cdef_file = ! $have_cdef_file && $line =~ m/^\s*classdef/; } next if $have_cdef_file; last; } 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; ## Instead of jumping out here unconditionally, should we ## attempt to extract multiple help comment blocks in a ## classdef file by searching forward for the next line that ## begins with "function" and then saving the first comment ## block after that? We will need a way to recognize the ## method name to print the docstring separator line. Maybe ## we should just be using Octave's parser and help system for ## this job? ## if ($have_cdef_file) ## { ## while (my $line = <$fh>) ## { ## last if $line =~ /^\s*function/; ## } ## } ## else ## { ## last; ## } } } close ($fh); return @help_txt; }