Mercurial > hg > octave-nkf

annotate scripts/help/doc_cache_create.m @ 20770:c1a6c31ac29a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
eliminate more simple uses of error_state * ov-classdef.cc: Eliminate simple uses of error_state.
author John W. Eaton <jwe@octave.org>
date Tue, 06 Oct 2015 00:20:02 -0400
parents 7503499a252b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19898
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19305
diff changeset
1 ## Copyright (C) 2009-2015 Søren Hauberg
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
2 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
4 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
8 ## your option) any later version.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
9 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
13 ## General Public License for more details.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
14 ##
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
18
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
19 ## -*- texinfo -*-
20368
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
20 ## @deftypefn {Function File} {} doc_cache_create (@var{out_file}, @var{directory})
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
21 ## @deftypefnx {Function File} {} doc_cache_create (@var{out_file})
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
22 ## @deftypefnx {Function File} {} doc_cache_create ()
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
23 ## Generate documentation cache for all functions in @var{directory}.
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
24 ##
20368
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
25 ## A documentation cache is generated for all functions in @var{directory}
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
26 ## which may be a single string or a cell array of strings. The cache is used
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
27 ## to speed up the function @code{lookfor}.
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
28 ##
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
29 ## The cache is saved in the file @var{out_file} which defaults to the value
7503499a252b doc: Update docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20038
diff changeset
30 ## @file{doc-cache} if not given.
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
31 ##
18602
f51c1498b9f3 doc: Replace "builtin" with "built-in" for consistency and correctness.
Rik <rik@octave.org>
parents: 17744
diff changeset
32 ## If no directory is given (or it is the empty matrix), a cache for built-in
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
33 ## operators, etc. is generated.
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
34 ##
16872
5372068bb148 Rename gen_doc_cache() to doc_cache_create().
Rik <rik@octave.org>
parents: 16724
diff changeset
35 ## @seealso{doc_cache_file, lookfor, path}
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
36 ## @end deftypefn
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
37
16872
5372068bb148 Rename gen_doc_cache() to doc_cache_create().
Rik <rik@octave.org>
parents: 16724
diff changeset
38 function doc_cache_create (out_file = "doc-cache", directory = [])
13067
875577a19d70 codesprint: Add 1 input validation test for gen_doc_cache()
Rik <octave@nomad.inbox5.com>
parents: 11588
diff changeset
39
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
40 ## Check input
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14486
diff changeset
41 if (! ischar (out_file))
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
42 print_usage ();
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
43 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
44
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
45 ## Generate cache
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
46 if (isempty (directory))
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
47 cache = gen_builtin_cache ();
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
48 elseif (iscell (directory))
17386
6dbc866379e2 Replace cellfun() occurrences with faster code where possible.
Rik <rik@octave.org>
parents: 17338
diff changeset
49 if (all (cellfun ("isclass", directory, "char")))
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
50 cache = gen_doc_cache_in_dir (directory);
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
51 else
16872
5372068bb148 Rename gen_doc_cache() to doc_cache_create().
Rik <rik@octave.org>
parents: 16724
diff changeset
52 error ("doc_cache_create: cell must contain only strings");
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14486
diff changeset
53 endif
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
54 elseif (ischar (directory))
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
55 cache = gen_doc_cache_in_dir (directory);
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
56 else
16872
5372068bb148 Rename gen_doc_cache() to doc_cache_create().
Rik <rik@octave.org>
parents: 16724
diff changeset
57 error ("doc_cache_create: second input argument must be a string or a cell of strings");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
58 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
59
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
60 ## Save cache
8863
34a821854961 pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents: 8861
diff changeset
61 if (! isempty (cache))
19305
72e32208ff77 Don't save build timestamp in doc-cache header comment (bug #43087)
Mike Miller <mtmiller@ieee.org>
parents: 18602
diff changeset
62 save_header_format_string (["# doc-cache created by Octave " OCTAVE_VERSION], "local");
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
63 save ("-text", out_file, "cache");
8863
34a821854961 pkg.m (generate_lookfor_cache): generate a DOC file for each directory
Jason Riedy <jason@acm.org>
parents: 8861
diff changeset
64 endif
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
65
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
66 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
67
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
68 function [text, first_sentence, status] = handle_function (f, text, format)
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
69 first_sentence = "";
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
70 ## Skip functions that start with __ as these shouldn't be searched by lookfor
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
71 if (length (f) > 2 && all (f (1:2) == "_"))
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
72 status = 1;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
73 return;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
74 endif
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
75
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
76 ## Take action depending on help text format
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
77 switch (lower (format))
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
78 case "plain text"
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
79 status = 0;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
80 case "texinfo"
8860
257ed585b471 gen_doc_cache.m: call __makeinfo__, not makeinfo
Jason Riedy <jason@acm.org>
parents: 8729
diff changeset
81 [text, status] = __makeinfo__ (text, "plain text");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
82 case "html"
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
83 [text, status] = strip_html_tags (text);
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
84 otherwise
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
85 status = 1;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
86 endswitch
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
87
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
88 ## Did we get the help text?
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
89 if (status != 0 || isempty (text))
16872
5372068bb148 Rename gen_doc_cache() to doc_cache_create().
Rik <rik@octave.org>
parents: 16724
diff changeset
90 warning ("doc_cache_create: unusable help text found in file '%s'", f);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
91 return;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
92 endif
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
93
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
94 ## Get first sentence of help text
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
95 first_sentence = get_first_help_sentence (f);
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
96 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
97
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
98 function cache = create_cache (list)
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
99 cache = {};
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
100
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
101 ## For each function:
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
102 for n = 1:length (list)
17386
6dbc866379e2 Replace cellfun() occurrences with faster code where possible.
Rik <rik@octave.org>
parents: 17338
diff changeset
103 f = list{n};
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
104
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
105 ## Get help text
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
106 [text, format] = get_help_text (f);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
107
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
108 [text, first_sentence, status] = handle_function (f, text, format);
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
109
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
110 ## Did we get the help text?
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
111 if (status != 0)
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
112 continue;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
113 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
114
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
115 ## Store the help text
17386
6dbc866379e2 Replace cellfun() occurrences with faster code where possible.
Rik <rik@octave.org>
parents: 17338
diff changeset
116 cache(1, end+1) = f;
6dbc866379e2 Replace cellfun() occurrences with faster code where possible.
Rik <rik@octave.org>
parents: 17338
diff changeset
117 cache(2, end) = text;
6dbc866379e2 Replace cellfun() occurrences with faster code where possible.
Rik <rik@octave.org>
parents: 17338
diff changeset
118 cache(3, end) = first_sentence;
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
119 endfor
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
120 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
121
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
122 function cache = gen_doc_cache_in_dir (directory)
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
123
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
124 ## If 'directory' is not in the current path, add it so we search it
16724
b7667fcb9fbc Substitute ostrsplit() for strsplit().
Ben Abbott <bpabbott@mac.com>
parents: 16403
diff changeset
125 dir_in_path = ismember (directory, ostrsplit (path (), pathsep ()));
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
126
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17243
diff changeset
127 ## dirs not in path
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14486
diff changeset
128 if (! iscell (directory))
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
129 directory = {directory};
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14486
diff changeset
130 endif
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19898
diff changeset
131 dirs_notpath = {directory{! dir_in_path}};
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
132
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17243
diff changeset
133 ## add them
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14486
diff changeset
134 if (! isempty (dirs_notpath))
17386
6dbc866379e2 Replace cellfun() occurrences with faster code where possible.
Rik <rik@octave.org>
parents: 17338
diff changeset
135 addpath (dirs_notpath{:});
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14486
diff changeset
136 endif
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
137
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17243
diff changeset
138 ## create cache
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
139 func = @(s_) create_cache (__list_functions__ (s_));
17386
6dbc866379e2 Replace cellfun() occurrences with faster code where possible.
Rik <rik@octave.org>
parents: 17338
diff changeset
140 cache = cellfun (func, directory, "UniformOutput", false);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
141
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17243
diff changeset
142 ## concatenate results
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
143 cache = [cache{:}];
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
144
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17243
diff changeset
145 ## remove dirs form path
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14486
diff changeset
146 if (! isempty (dirs_notpath))
17386
6dbc866379e2 Replace cellfun() occurrences with faster code where possible.
Rik <rik@octave.org>
parents: 17338
diff changeset
147 rmpath (dirs_notpath{:});
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14486
diff changeset
148 endif
14486
6bed5141fdad Let gen_doc_cache_in_dir accept multiple directories as input.
Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
parents: 14138
diff changeset
149
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
150 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
151
8729
d65a0a1780b6 Simplify documentation cache generation to only handle one directory per call to 'gen_doc_cache'
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
152 function cache = gen_builtin_cache ()
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
153 operators = __operators__ ();
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
154 keywords = __keywords__ ();
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
155 builtins = __builtins__ ();
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
156 list = {operators{:}, keywords{:}, builtins{:}};
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
157
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
158 cache = create_cache (list);
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
159 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
160
13067
875577a19d70 codesprint: Add 1 input validation test for gen_doc_cache()
Rik <octave@nomad.inbox5.com>
parents: 11588
diff changeset
161
20038
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19898
diff changeset
162 ## No true tests desirable for this function.
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19898
diff changeset
163 ## Test input validation
16872
5372068bb148 Rename gen_doc_cache() to doc_cache_create().
Rik <rik@octave.org>
parents: 16724
diff changeset
164 %!error doc_cache_create (1)
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17336
diff changeset
165