view src/mkgendoc @ 14237:11949c9795a0

Revamp %!demos in m-files to use Octave coding conventions on spacing, etc. Add clf() to all demos using plot features to get reproducibility. Use 64 as input to all colormaps (jet (64)) to get reproducibility. * bicubic.m, cell2mat.m, celldisp.m, cplxpair.m, interp1.m, interp2.m, interpft.m, interpn.m, profile.m, profshow.m, convhull.m, delaunay.m, griddata.m, inpolygon.m, voronoi.m, autumn.m, bone.m, contrast.m, cool.m, copper.m, flag.m, gmap40.m, gray.m, hot.m, hsv.m, image.m, imshow.m, jet.m, ocean.m, pink.m, prism.m, rainbow.m, spring.m, summer.m, white.m, winter.m, condest.m, onenormest.m, axis.m, clabel.m, colorbar.m, comet.m, comet3.m, compass.m, contour.m, contour3.m, contourf.m, cylinder.m, daspect.m, ellipsoid.m, errorbar.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m, ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, fplot.m, grid.m, hold.m, isosurface.m, legend.m, loglog.m, loglogerr.m, pareto.m, patch.m, pbaspect.m, pcolor.m, pie.m, pie3.m, plot3.m, plotmatrix.m, plotyy.m, polar.m, quiver.m, quiver3.m, rectangle.m, refreshdata.m, ribbon.m, rose.m, scatter.m, scatter3.m, semilogx.m, semilogxerr.m, semilogy.m, semilogyerr.m, shading.m, slice.m, sombrero.m, stairs.m, stem.m, stem3.m, subplot.m, surf.m, surfc.m, surfl.m, surfnorm.m, text.m, title.m, trimesh.m, triplot.m, trisurf.m, uigetdir.m, uigetfile.m, uimenu.m, uiputfile.m, waitbar.m, xlim.m, ylim.m, zlim.m, mkpp.m, pchip.m, polyaffine.m, spline.m, bicgstab.m, cgs.m, gplot.m, pcg.m, pcr.m, treeplot.m, strtok.m, demo.m, example.m, rundemos.m, speed.m, test.m, calendar.m, datestr.m, datetick.m, weekday.m: Revamp %!demos to use Octave coding conventions on spacing, etc.
author Rik <octave@nomad.inbox5.com>
date Fri, 20 Jan 2012 12:59:53 -0800
parents 72c96de7a403
children
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/>.

SED=${SED:-'sed'}

if test $# -ne 1; then
  echo "usage: mkgendoc f1" 1>&2
  exit 1
fi

DOC_FILES=`cat $1`

if test -z "$DOC_FILES"; then
  echo "mkgendoc: DOC_FILES is empty!" 1>&2
  exit 1
fi

cat << \EOF
// DO NOT EDIT!  Generated automatically by mkgendoc

#if defined (__DECCXX)
#define __USE_STD_IOSTREAM
#endif

#include <iostream>
#include <string>

#define XDEFUN_FILE_NAME(name) \
  std::string file_name = name;

#define XDEFUN_DLD_INTERNAL(name, args_name, nargout_name, doc) \
  print_doc_string (#name, file_name, doc);

#define XDEFUNX_DLD_INTERNAL(name, fname, args_name, nargout_name, doc) \
  print_doc_string (name, file_name, doc);

#define XDEFUN_INTERNAL(name, args_name, nargout_name, doc) \
  print_doc_string (#name, file_name, doc);

#define XDEFCONSTFUN_INTERNAL(name, args_name, nargout_name, doc) \
  print_doc_string (#name, file_name, doc);

#define XDEFUNX_INTERNAL(name, fname, args_name, nargout_name, doc) \
  print_doc_string (name, file_name, doc);

#define XDEFALIAS_INTERNAL(alias, name)

#define XDEFVAR_INTERNAL(name, sname, defn, protect, chg_fcn, doc) \
  print_doc_string (#name, file_name, doc);

#define XDEFCONST_INTERNAL(name, defn, doc) \
  print_doc_string (#name, file_name, doc);

static void
print_doc_string (const std::string& name, const std::string& file_name,
                  const std::string& doc)
{
  std::cout << "";

  size_t len = name.length ();

  if (name[0] == '"' && name[len-1] == '"')
    std::cout << name.substr (1, len-2) << "\n";
  else
    std::cout << name << "\n";

  std::cout << "@c " << name << " " << file_name << "\n" << doc << "\n";
}

EOF

for file in $DOC_FILES; do
  fcn=`echo $file | $SED 's,.*/,,; s/\.df//; s/-/_/g;'`
  echo "static void"
  echo "print_${fcn}_doc_strings (void)"
  echo "{"
  cat $file
  echo "}"
  echo ""
done

cat << \EOF

int
main (void)
{
  std::cout
    << "### DO NOT EDIT!\n"
    << "###\n"
    << "### This file is generated automatically from the Octave sources.\n"
    << "### Edit those files instead and run make to update this file.\n"
    << std::endl;

EOF

for file in $DOC_FILES; do
  fcn=`echo $file | $SED 's,.*/,,; s/\.df//; s/-/_/g;'`
  echo "  print_${fcn}_doc_strings ();"
done

cat << \EOF

  return 0;
}
EOF

exit 0