#include "help.h"
Private Member Functions | |
string_vector | local_functions (void) const |
bool | raw_help_from_docstrings_file (const std::string &nm, std::string &h, bool &symbol_found) const |
bool | raw_help_from_file (const std::string &nm, std::string &h, std::string &file, bool &symbol_found) const |
bool | raw_help_from_symbol_table (const std::string &nm, std::string &h, std::string &w, bool &symbol_found) const |
template<typename T > | |
T | set (T &var, const T &new_val) |
Static Private Member Functions | |
static std::string | init_built_in_docstrings_file (void) |
static std::string | init_doc_cache_file (void) |
static std::string | init_info_file (void) |
static std::string | init_info_program (void) |
static std::string | init_texi_macros_file (void) |
|
inline |
octave_value octave::help_system::built_in_docstrings_file | ( | const octave_value_list & | args, |
int | nargout | ||
) |
|
inline |
Definition at line 59 of file help.h.
References m_built_in_docstrings_file.
|
inline |
Definition at line 61 of file help.h.
References file, and m_built_in_docstrings_file.
octave_value octave::help_system::doc_cache_file | ( | const octave_value_list & | args, |
int | nargout | ||
) |
|
inline |
Definition at line 68 of file help.h.
References m_doc_cache_file.
|
inline |
Definition at line 70 of file help.h.
References file, and m_doc_cache_file.
void octave::help_system::get_help_text | ( | const std::string & | name, |
std::string & | text, | ||
std::string & | format | ||
) | const |
void octave::help_system::get_help_text_from_file | ( | const std::string & | fname, |
std::string & | text, | ||
std::string & | format | ||
) | const |
octave_value octave::help_system::info_file | ( | const octave_value_list & | args, |
int | nargout | ||
) |
|
inline |
Definition at line 77 of file help.h.
References m_info_file.
|
inline |
Definition at line 79 of file help.h.
References file, and m_info_file.
octave_value octave::help_system::info_program | ( | const octave_value_list & | args, |
int | nargout | ||
) |
|
inline |
Definition at line 86 of file help.h.
References m_info_program.
|
inline |
Definition at line 88 of file help.h.
References file, and m_info_program.
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
staticprivate |
|
private |
string_vector octave::help_system::make_name_list | ( | void | ) | const |
octave_value octave::help_system::makeinfo_program | ( | const octave_value_list & | args, |
int | nargout | ||
) |
|
inline |
Definition at line 95 of file help.h.
References m_makeinfo_program.
|
inline |
Definition at line 97 of file help.h.
References file, and m_makeinfo_program.
std::string octave::help_system::raw_help | ( | const std::string & | , |
bool & | |||
) | const |
|
private |
|
private |
|
private |
|
inlineprivate |
octave_value octave::help_system::suppress_verbose_help_message | ( | const octave_value_list & | args, |
int | nargout | ||
) |
|
inline |
Definition at line 105 of file help.h.
References m_suppress_verbose_help_message.
Definition at line 110 of file help.h.
References m_suppress_verbose_help_message.
octave_value octave::help_system::texi_macros_file | ( | const octave_value_list & | args, |
int | nargout | ||
) |
|
inline |
Definition at line 117 of file help.h.
References m_texi_macros_file.
|
inline |
Definition at line 119 of file help.h.
References file, and m_texi_macros_file.
std::string octave::help_system::which | ( | const std::string & | name | ) | const |
std::string octave::help_system::which | ( | const std::string & | name, |
std::string & | type | ||
) | const |
|
private |
Definition at line 143 of file help.h.
Referenced by built_in_docstrings_file().
|
private |
Definition at line 147 of file help.h.
Referenced by doc_cache_file().
|
private |
Definition at line 151 of file help.h.
Referenced by info_file().
|
private |
Definition at line 155 of file help.h.
Referenced by info_program().
|
private |
|
private |
Definition at line 158 of file help.h.
Referenced by makeinfo_program().
|
private |
Definition at line 162 of file help.h.
Referenced by suppress_verbose_help_message().
|
private |
Definition at line 167 of file help.h.
Referenced by texi_macros_file().