help.hpp File Reference

#include <nk/bundle/help/help_catalog.hpp>
#include <nk/value/value.hpp>
#include <nk/value/span.hpp>
#include <memory_resource>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
class	nk::bundle::HelpLibrary
	Installs MATLAB-compatible help and documentation commands into the script Engine. More...

Functions
void	nk::bundle::registerHelpLibrary (Engine &engine)
	Convenience alias to install help system into an engine.
std::string	nk::bundle::help (const std::string &query="")
	Formats help text or catalog index for given function or topic name (help query).
Value	nk::bundle::help (Span< const Value > args, std::pmr::memory_resource *mr=nullptr)
	MATLAB script engine wrapper for help.
std::vector< std::string >	nk::bundle::what (const std::string &category="elmat")
	Lists all functions in specified category (what category).
Value	nk::bundle::what (Span< const Value > args, std::pmr::memory_resource *mr=nullptr)
	MATLAB script engine wrapper for what.
std::vector< std::string >	nk::bundle::builtins (const std::string &category="")
	Lists all built-in functions registered in the system or specified category (builtins).
Value	nk::bundle::builtins (Span< const Value > args, std::pmr::memory_resource *mr=nullptr)
	MATLAB script engine wrapper for builtins.
std::vector< std::string >	nk::bundle::categories ()
	Lists all registered documentation categories (categories).
Value	nk::bundle::categories (std::pmr::memory_resource *mr)
	Returns all registered categories as a cell array of strings.