Skip to content

Commit 36f56e2

Browse files
committed
docs: add comments
1 parent 46f0e4a commit 36f56e2

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

include/plugify/language_module.hpp

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ namespace plugify {
5757

5858
/**
5959
* @brief Shutdown the language module.
60-
* @return Result of the s.
60+
* @return Result of the shutdown, either void or string.
6161
*/
6262
virtual Result<void> Shutdown() = 0;
6363

@@ -82,25 +82,29 @@ namespace plugify {
8282
/**
8383
* @brief Handle plugin start event.
8484
* @param plugin Ref to the started plugin.
85+
* @return Result of the start, either void or string.
8586
*/
8687
virtual Result<void> OnPluginStart(const Extension& plugin) = 0;
8788

8889
/**
8990
* @brief Handle plugin update event.
9091
* @param plugin Ref to the started plugin.
9192
* @param deltaTime The time delta since the last update.
93+
* @return Result of the update, either void or string.
9294
*/
9395
virtual Result<void> OnPluginUpdate(const Extension& plugin, std::chrono::milliseconds deltaTime) = 0;
9496

9597
/**
9698
* @brief Handle plugin end event.
9799
* @param plugin Ref to the ended plugin.
100+
* @return Result of the end, either void or string.
98101
*/
99102
virtual Result<void> OnPluginEnd(const Extension& plugin) = 0;
100103

101104
/**
102105
* @brief Handle method export event.
103106
* @param plugin Ref to the plugin exporting a method.
107+
* @return Result of the export, either void or string.
104108
*/
105109
virtual Result<void> OnMethodExport(const Extension& plugin) = 0;
106110

0 commit comments

Comments
 (0)