help.h File Reference

#include <iosfwd>
#include <string>

Include dependency graph for help.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
OCTINTERP_API std::string	do_which (const std::string &name)
OCTINTERP_API void	install_built_in_docstrings (void)
string_vector	make_name_list (void)
OCTINTERP_API std::string	raw_help (const std::string &, bool &)

Variables
OCTINTERP_API std::string	Vdoc_cache_file
OCTINTERP_API std::string	Vinfo_file
OCTINTERP_API std::string	Vinfo_program
OCTINTERP_API std::string	Vtexi_macros_file

Function Documentation

OCTINTERP_API std::string do_which

(

const std::string &

name

)

Definition at line 1265 of file help.cc.

References do_which().

OCTINTERP_API void install_built_in_docstrings

(

void

)

Definition at line 962 of file help.cc.

References octave_function::document(), symbol_table::find_built_in_function(), octave_value::function_value(), octave_value::is_defined(), OCTAVE_LOCAL_BUFFER, and Vbuilt_in_docstrings_file.

Referenced by install_builtins().

string_vector make_name_list

(

void

)

Definition at line 794 of file help.cc.

References autoloaded_functions(), symbol_table::built_in_function_names(), symbol_table::cmdline_function_names(), load_path::fcn_names(), Array< T >::length(), and symbol_table::variable_names().

Referenced by generate_possible_completions().

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

Definition at line 925 of file help.cc.

References f, keywords_map(), operators_map(), raw_help_from_file(), raw_help_from_map(), raw_help_from_symbol_table(), and Faddeeva::w().

Referenced by do_get_help_text().

Variable Documentation

OCTINTERP_API std::string Vdoc_cache_file

Definition at line 72 of file help.cc.

Referenced by set_default_doc_cache_file().

OCTINTERP_API std::string Vinfo_file

Definition at line 81 of file help.cc.

Referenced by set_default_info_file(), and webinfo::webinfo().

OCTINTERP_API std::string Vinfo_program

Definition at line 85 of file help.cc.

Referenced by set_default_info_prog().

OCTINTERP_API std::string Vtexi_macros_file

Definition at line 77 of file help.cc.

Referenced by set_default_texi_macros_file().