Skip to content

Commit

Permalink
[fix] docs
Browse files Browse the repository at this point in the history
  • Loading branch information
begla committed Mar 31, 2024
1 parent 6b26601 commit 91aa2dc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
2 changes: 2 additions & 0 deletions iolite_docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@
}
html_logo = '_static/images/logo.png'
html_static_path = ['_static']

latex_engine = 'xelatex'
8 changes: 4 additions & 4 deletions iolite_plugins/lua_plugin/init_state.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1623,7 +1623,7 @@ void script_init_state(sol::state& s)
s["Log"] = s.create_table();
s["Log"]["load"] = [&s]() {
// @namespace Log
// @category Logging Functions to log to the console and log file.
// @category Log Functions to log to the console and log file.
// @copy_category Interface

// @function log_info
Expand All @@ -1643,7 +1643,7 @@ void script_init_state(sol::state& s)
s["Events"] = s.create_table();
s["Events"]["load"] = [&s]() {
// @namespace Events
// @category Functions for working with user events.
// @category Events Functions for listening for custom user events and sending them with and without payloads.
// @copy_category Interface

// @function register_event_listener
Expand All @@ -1661,7 +1661,7 @@ void script_init_state(sol::state& s)
// @param source_entity Ref The entity the event is originating from.
// @param event_type string The type of the event to post.
s["Events"]["post_event"] = [](io_ref_t source_entity, const char* event_type) {
post_event( source_entity, event_type, nullptr, 0u);
post_event(source_entity, event_type, nullptr, 0u);
};
// @function post_event_with_payload
// @summary Posts the given event type from the given source entity with the provided payload of variants.
Expand All @@ -1672,7 +1672,7 @@ void script_init_state(sol::state& s)
std::vector<io_variant_t> vars(variants.size());
for (uint32_t i=0u; i<variants.size(); ++i)
vars[i] = variants[1u + i];
post_event( source_entity, event_type, vars.data(), vars.size());
post_event(source_entity, event_type, vars.data(), vars.size());
};
};

Expand Down

0 comments on commit 91aa2dc

Please sign in to comment.