summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSadie Powell <sadie@witchery.services>2020-04-01 14:32:02 +0100
committerSadie Powell <sadie@witchery.services>2020-04-01 14:32:02 +0100
commite19674d50ad3bf8f6881677e039aac56b62a6981 (patch)
treed3d238e810fa34c5bf2f2f24152886ce25a9682b
parentbec70fca51a6094380f890f1d5b89cf9c6ab46bd (diff)
Document Module::Prioritize.
-rw-r--r--include/modules.h7
1 files changed, 3 insertions, 4 deletions
diff --git a/include/modules.h b/include/modules.h
index e4e439f7c..75bbcb8de 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -262,7 +262,7 @@ class CoreExport Module : public classbase, public usecountbase
/** Module setup
* \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
*/
- virtual void init() {}
+ virtual void init() { }
/** Clean up prior to destruction
* If you override, you must call this AFTER your module's cleanup
@@ -274,9 +274,8 @@ class CoreExport Module : public classbase, public usecountbase
*/
virtual ~Module();
- virtual void Prioritize()
- {
- }
+ /** Called when the hooks provided by a module need to be prioritised. */
+ virtual void Prioritize() { }
/** This method is called when you should reload module specific configuration:
* on boot, on a /REHASH and on module load.