Mercurial > hg > octave-lyh
view libinterp/corefcn/help.h @ 17405:0bf2fc8562c9
doc: Update documentation for file and directory functions.
* libinterp/corefcn/dirfns.cc(Fpwd, Freaddir, Fmkdir, Frmdir, Freadlink, Ffnmatch): Redo docstring.
* libinterp/corefcn/dirfns.cc(Fcd): Redo docstring. Return previous working
directory if nargout > 0.
* libinterp/corefcn/dirfns.cc(Flink, Fsymlink, Frename): Redo docstring.
Re-order return values so that highest numbered value is assigned first to
avoid re-sizing octave_value_list each time.
* libinterp/corefcn/syscalls.cc(Flstat, Fmkfifo, FS_ISREG, FS_ISDIR, FS_ISCHR,
FS_ISBLK, FS_ISFIFO, FS_ISLNK, FS_ISSOCK): Redo docstring.
* scripts/general/isdir.m: Add more xrefs to @seealso.
* scripts/miscellaneous/copyfile.m: Add more xrefs to @seealso.
* scripts/miscellaneous/dir.m: Redo docstring.
* scripts/miscellaneous/ls.m: Add more xrefs to @seealso.m.
* scripts/miscellaneous/movefile.m: Add more xrefs to @seealso.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 09 Sep 2013 14:30:31 -0700 |
parents | 68fc671a9339 |
children |
line wrap: on
line source
/* Copyright (C) 1993-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/>. */ #if !defined (octave_help_h) #define octave_help_h 1 #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&); extern OCTINTERP_API void install_built_in_docstrings (void); // 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