view libinterp/corefcn/help.h @ 23433:c9fab0bc983e

maint: Use convention 'int& x' for naming references. * ButtonGroup.cc, Canvas.cc, Canvas.h, annotation-dialog.cc, annotation-dialog.h, dialog.h, documentation-dock-widget.cc, files-dock-widget.cc, files-dock-widget.h, find-files-dialog.cc, find-files-dialog.h, find-files-model.cc, find-files-model.h, history-dock-widget.cc, history-dock-widget.h, file-editor-tab.cc, file-editor-tab.h, file-editor.cc, file-editor.h, main-window.cc, main-window.h, octave-qt-link.h, parser.cc, parser.h, webinfo.cc, webinfo.h, settings-dialog.cc, bsxfun.cc, call-stack.cc, call-stack.h, fft.cc, fft2.cc, fftn.cc, gl-render.cc, graphics.cc, graphics.in.h, input.cc, load-save.cc, ls-hdf5.cc, ls-hdf5.h, octave-link.h, pr-output.cc, regexp.cc, sparse-xdiv.cc, sparse-xdiv.h, symtab.cc, xdiv.cc, xdiv.h, zfstream.h, __eigs__.cc, __ode15__.cc, ov-base.h, ov-builtin.cc, ov-cx-sparse.h, ov-fcn-handle.cc, ov-fcn-handle.h, ov.cc, ov.h, jit-ir.h, jit-typeinfo.cc, jit-typeinfo.h, pt-jit.cc, pt-jit.h, CMatrix.cc, CMatrix.h, CSparse.cc, CSparse.h, MatrixType.cc, MatrixType.h, dDiagMatrix.cc, dMatrix.cc, dMatrix.h, dSparse.cc, dSparse.h, fCMatrix.cc, fCMatrix.h, fDiagMatrix.cc, fMatrix.cc, fMatrix.h, eigs-base.cc, oct-fftw.cc, oct-rand.h, sparse-dmsolve.cc, kpse.cc, lo-regexp.h: Use convention 'int& x' for naming references.
author Rik <rik@octave.org>
date Mon, 24 Apr 2017 17:20:37 -0700
parents 092078913d54
children b2d55b52ee51
line wrap: on
line source

/*

Copyright (C) 1993-2017 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/>.

*/

#if ! defined (octave_help_h)
#define octave_help_h 1

#include "octave-config.h"

#include <iosfwd>
#include <string>

class string_vector;

extern string_vector make_name_list (void);

extern OCTINTERP_API std::string raw_help (const std::string&, bool&);

// Name of the doc cache file specified on the command line.
// (--doc-cache-file file)
extern OCTINTERP_API std::string Vdoc_cache_file;

// Name of the file containing local Texinfo macros that are prepended
// to doc strings before processing.
// (--texi-macros-file)
extern OCTINTERP_API std::string Vtexi_macros_file;

// Name of the info file specified on command line.
// (--info-file file)
extern OCTINTERP_API std::string Vinfo_file;

// Name of the info reader we'd like to use.
// (--info-program program)
extern OCTINTERP_API std::string Vinfo_program;

extern OCTINTERP_API std::string do_which (const std::string& name);

#endif