GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | List of all members
help_system Class Reference

#include "help.h"

Public Member Functions

 help_system (interpreter &interp)
 
std::string built_in_docstrings_file () const
 
octave_value built_in_docstrings_file (const octave_value_list &args, int nargout)
 
std::string built_in_docstrings_file (const std::string &file)
 
std::string doc_cache_file () const
 
octave_value doc_cache_file (const octave_value_list &args, int nargout)
 
std::string doc_cache_file (const std::string &file)
 
void get_help_text (const std::string &name, std::string &text, std::string &format) const
 
void get_help_text_from_file (const std::string &fname, std::string &text, std::string &format) const
 
std::string info_file () const
 
octave_value info_file (const octave_value_list &args, int nargout)
 
std::string info_file (const std::string &file)
 
std::string info_program () const
 
octave_value info_program (const octave_value_list &args, int nargout)
 
std::string info_program (const std::string &file)
 
string_vector make_name_list () const
 
std::string makeinfo_program () const
 
octave_value makeinfo_program (const octave_value_list &args, int nargout)
 
std::string makeinfo_program (const std::string &file)
 
std::string raw_help (const std::string &, bool &) const
 
bool suppress_verbose_help_message () const
 
bool suppress_verbose_help_message (bool flag)
 
octave_value suppress_verbose_help_message (const octave_value_list &args, int nargout)
 
std::string texi_macros_file () const
 
octave_value texi_macros_file (const octave_value_list &args, int nargout)
 
std::string texi_macros_file (const std::string &file)
 
std::string which (const std::string &name) const
 
std::string which (const std::string &name, std::string &type) const
 

Detailed Description

Definition at line 44 of file help.h.

Constructor & Destructor Documentation

◆ help_system()

help_system::help_system ( interpreter &  interp)
inline

Definition at line 48 of file help.h.

Member Function Documentation

◆ built_in_docstrings_file() [1/3]

std::string help_system::built_in_docstrings_file ( ) const
inline

Definition at line 63 of file help.h.

◆ built_in_docstrings_file() [2/3]

octave_value help_system::built_in_docstrings_file ( const octave_value_list &  args,
int  nargout 
)

◆ built_in_docstrings_file() [3/3]

std::string help_system::built_in_docstrings_file ( const std::string &  file)
inline

Definition at line 65 of file help.h.

◆ doc_cache_file() [1/3]

std::string help_system::doc_cache_file ( ) const
inline

Definition at line 72 of file help.h.

◆ doc_cache_file() [2/3]

octave_value help_system::doc_cache_file ( const octave_value_list &  args,
int  nargout 
)

◆ doc_cache_file() [3/3]

std::string help_system::doc_cache_file ( const std::string &  file)
inline

Definition at line 74 of file help.h.

◆ get_help_text()

void help_system::get_help_text ( const std::string &  name,
std::string &  text,
std::string &  format 
) const

◆ get_help_text_from_file()

void help_system::get_help_text_from_file ( const std::string &  fname,
std::string &  text,
std::string &  format 
) const

◆ info_file() [1/3]

std::string help_system::info_file ( ) const
inline

Definition at line 81 of file help.h.

◆ info_file() [2/3]

octave_value help_system::info_file ( const octave_value_list &  args,
int  nargout 
)

◆ info_file() [3/3]

std::string help_system::info_file ( const std::string &  file)
inline

Definition at line 83 of file help.h.

◆ info_program() [1/3]

std::string help_system::info_program ( ) const
inline

Definition at line 90 of file help.h.

◆ info_program() [2/3]

octave_value help_system::info_program ( const octave_value_list &  args,
int  nargout 
)

◆ info_program() [3/3]

std::string help_system::info_program ( const std::string &  file)
inline

Definition at line 92 of file help.h.

◆ make_name_list()

string_vector help_system::make_name_list ( ) const

◆ makeinfo_program() [1/3]

std::string help_system::makeinfo_program ( ) const
inline

Definition at line 99 of file help.h.

◆ makeinfo_program() [2/3]

octave_value help_system::makeinfo_program ( const octave_value_list &  args,
int  nargout 
)

◆ makeinfo_program() [3/3]

std::string help_system::makeinfo_program ( const std::string &  file)
inline

Definition at line 101 of file help.h.

◆ raw_help()

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

◆ suppress_verbose_help_message() [1/3]

bool help_system::suppress_verbose_help_message ( ) const
inline

Definition at line 109 of file help.h.

◆ suppress_verbose_help_message() [2/3]

bool help_system::suppress_verbose_help_message ( bool  flag)
inline

Definition at line 114 of file help.h.

◆ suppress_verbose_help_message() [3/3]

octave_value help_system::suppress_verbose_help_message ( const octave_value_list &  args,
int  nargout 
)

◆ texi_macros_file() [1/3]

std::string help_system::texi_macros_file ( ) const
inline

Definition at line 121 of file help.h.

◆ texi_macros_file() [2/3]

octave_value help_system::texi_macros_file ( const octave_value_list &  args,
int  nargout 
)

◆ texi_macros_file() [3/3]

std::string help_system::texi_macros_file ( const std::string &  file)
inline

Definition at line 123 of file help.h.

◆ which() [1/2]

std::string help_system::which ( const std::string &  name) const

◆ which() [2/2]

std::string help_system::which ( const std::string &  name,
std::string &  type 
) const
The documentation for this class was generated from the following file: