Mercurial > hg > octave-lyh

annotate scripts/deprecated/gen_doc_cache.m @ 17392:8c5878260636

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Fix typo in fieldnames docstring. * scripts/general/fieldnames.m: Eliminate stray parenthesis in docstring.
author Rik <rik@octave.org>
date Fri, 06 Sep 2013 08:35:59 -0700
parents 898f902006df
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16873
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
1 ## Copyright (C) 2013 Rik Wehbring
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
18
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Function File} {} gen_doc_cache (@var{out_file}, @var{directory})
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
21 ## This function has been deprecated. Use @code{doc_cache_create} instead.
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
22 ## @seealso{doc_cache_create}
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
23 ## @end deftypefn
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
24
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
25 ## Deprecated in 3.8
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
26
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
27 function gen_doc_cache (varargin)
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
28
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
29 persistent warned = false;
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
30 if (! warned)
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
31 warned = true;
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
32 warning ("Octave:deprecated-function",
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
33 "gen_doc_cache is obsolete and will be removed from a future version of Octave, please use doc_cache_create instead");
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
34 endif
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
35
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
36 doc_cache_create (varargin{:});
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
37
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
38 endfunction
898f902006df Add deprecated script gen_doc_cache.m missing from 5372068bb148.
Rik <rik@octave.org>
parents:
diff changeset
39