Browse Source

Fix doc comment for Module.

tags/v2.0.0
Andrew Belt 3 years ago
parent
commit
02560a43da
1 changed files with 4 additions and 1 deletions
  1. +4
    -1
      include/engine/Module.hpp

+ 4
- 1
include/engine/Module.hpp View File

@@ -285,7 +285,7 @@ struct Module {
Expander& getRightExpander() {
return rightExpander;
}
/** Returns the left Expander if `side` is false, andright Expander if `side` is true. */
/** Returns the left Expander if `side` is false, and the right Expander if `side` is true. */
Expander& getExpander(bool side) {
return side ? rightExpander : leftExpander;
}
@@ -327,8 +327,11 @@ struct Module {
Remember to call `Module::fromJson(rootJ)` within your overridden method.
*/
virtual void fromJson(json_t* rootJ);

/** Serializes the "params" object. */
virtual json_t* paramsToJson();
virtual void paramsFromJson(json_t* rootJ);

/** Override to store extra internal data in the "data" property of the module's JSON object. */
virtual json_t* dataToJson() {
return NULL;


Loading…
Cancel
Save