Mercurial > octave
annotate libinterp/corefcn/help.h @ 22198:f6181638f6c5
search docstrings file for built-in and dld function help text (bug #48554)
Load help text as needed from the built-in docstrings file for
built-in and dynamically loaded .oct file functions.
* help.h, help.cc (install_built_in_docstrings): Delete.
(raw_help_from_docstrings_file): New static function.
(raw_help): Call raw_help_from_docstrings_file if help text is not
found or if it is marked as external.
* mk-builtins.sh: Don't emit call to install_built_in_docstrings.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 02 Aug 2016 03:10:51 -0400 |
parents | 1473547f50f5 |
children | bac0d6f07a3e |
rev | line source |
---|---|
1 | 1 /* |
2 | |
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
3 Copyright (C) 1993-2015 John W. Eaton |
1 | 4 |
5 This file is part of Octave. | |
6 | |
7 Octave is free software; you can redistribute it and/or modify it | |
8 under the terms of the GNU General Public License as published by the | |
7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
10 option) any later version. | |
1 | 11 |
12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
15 for more details. | |
16 | |
17 You should have received a copy of the GNU General Public License | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
1 | 20 |
21 */ | |
22 | |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
23 #if ! defined (octave_help_h) |
383 | 24 #define octave_help_h 1 |
1 | 25 |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
26 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20791
diff
changeset
|
27 |
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
28 #include <iosfwd> |
1755 | 29 #include <string> |
30 | |
31 class string_vector; | |
32 | |
3016 | 33 extern string_vector make_name_list (void); |
1 | 34 |
6692 | 35 extern OCTINTERP_API std::string raw_help (const std::string&, bool&); |
6243 | 36 |
8861 | 37 // Name of the doc cache file specified on the command line. |
38 // (--doc-cache-file file) | |
15598
bb7cbef712f1
Add missing OCTINTTERP_API decorator.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
15470
diff
changeset
|
39 extern OCTINTERP_API std::string Vdoc_cache_file; |
8861 | 40 |
14614
4e9dc46d4125
handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
41 // Name of the file containing local Texinfo macros that are prepended |
4e9dc46d4125
handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
42 // to doc strings before processing. |
4e9dc46d4125
handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
43 // (--texi-macros-file) |
15598
bb7cbef712f1
Add missing OCTINTTERP_API decorator.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
15470
diff
changeset
|
44 extern OCTINTERP_API std::string Vtexi_macros_file; |
14614
4e9dc46d4125
handle texinfo macros consistently in help system and manual
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
45 |
2202 | 46 // Name of the info file specified on command line. |
47 // (--info-file file) | |
15598
bb7cbef712f1
Add missing OCTINTTERP_API decorator.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
15470
diff
changeset
|
48 extern OCTINTERP_API std::string Vinfo_file; |
2202 | 49 |
50 // Name of the info reader we'd like to use. | |
51 // (--info-program program) | |
15598
bb7cbef712f1
Add missing OCTINTTERP_API decorator.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
15470
diff
changeset
|
52 extern OCTINTERP_API std::string Vinfo_program; |
2202 | 53 |
15598
bb7cbef712f1
Add missing OCTINTTERP_API decorator.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
15470
diff
changeset
|
54 extern OCTINTERP_API std::string do_which (const std::string& name); |
7082 | 55 |
1 | 56 #endif |