view scripts/mkdoc @ 8828:8463d1a2e544

Doc fixes. * 2]$$. => 2].$$ * @var{extrapval} => @var{extrapval}. * call helloworld.oct => called @file{helloworld.oct} * @itemize => @table @code * shows. => shows: * save => @code{save} * @ref{Breakpoints} => @pxref{Breakpoints} * add @noindent following example * which is computed => and compute it * clarify wording * remove comma * good => well * set => number * by writing => with the command * has the option of directly calling => can call * [-like-] {+of the right size,+} * solvers => routines * handle => test for * add introductory section * add following * {+the+} [0..bitmax] => [0,bitmax] * of the => with * number => value * add usual * Besides when doing comparisons, logical => Logical {+also+} * array comparison => array, comparisons * param => parameter * works very similar => is similar * strings, => strings * most simple => simplest * easier => more easily * like => as * called => called, * clarify wording * you should simply type => use * clarify wording * means => way * equally => also * [-way much-] {+way+} * add with mean value parameter given by the first argument, @var{l} * add Functions described as @dfn{mapping functions} apply the given operation to each element when given a matrix argument. * in this brief introduction => here * It is worth noticing => Note * add following * means => ways
author Brian Gough <bjg@network-theory.co.uk>
date Fri, 20 Feb 2009 11:17:01 -0500
parents dd52e541418b
children eb63fbe60fab
line wrap: on
line source

#! /bin/sh
#
# Copyright (C) 1999, 2002, 2005, 2007 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/>.

set -e

FIND=${FIND:-'find'}

PERL=${PERL:-'perl'}

if test $# -eq 1; then
  d=$1
elif test $# -eq 0; then
  d=.
else
  echo "usage: mkdoc [directory]" 1>&2
  exit 1
fi

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
  $FIND $d -name '*.m' | \
    $PERL -ne 'm{(.*)/(.*)\.m};
               for (qx{./gethelp $2 < $_}) {
                 s/^\s+\@/\@/ unless $i_am_in_example;
                 s/^\s+\@group/\@group/;
                 s/^\s+\@end\s+group/\@end\s+group/;
                 $i_am_in_example = 1 if /\s*\@example/;
                 $i_am_in_example = 0 if /\s*\@end\s+example/;
                 print;
               }'  
else
  echo "gethelp program seems to be missing!" 1>&2
  exit 1
fi