summaryrefslogtreecommitdiff
path: root/modules_v3/ckeditor/module.php
diff options
context:
space:
mode:
Diffstat (limited to 'modules_v3/ckeditor/module.php')
-rw-r--r--modules_v3/ckeditor/module.php11
1 files changed, 10 insertions, 1 deletions
diff --git a/modules_v3/ckeditor/module.php b/modules_v3/ckeditor/module.php
index 2a7ce3db03..7c7506bf60 100644
--- a/modules_v3/ckeditor/module.php
+++ b/modules_v3/ckeditor/module.php
@@ -34,7 +34,16 @@ class ckeditor_WT_Module extends WT_Module {
return /* I18N: Description of the “CKEditor” module. WYSIWYG = “what you see is what you get” */ WT_I18N::translate('Allow other modules to edit text using a “WYSIWYG” editor, instead of using HTML codes.');
}
- // Convert <textarea class="html-edit"> fields to CKEditor fields
+ /**
+ * Convert <textarea class="html-edit"> fields to CKEditor fields
+ *
+ * This function needs to be called *after* we have sent the page header and
+ * before we have sent the page footer.
+ *
+ * @param WT_Controller_Base $controller
+ *
+ * @return void
+ */
public static function enableEditor($controller) {
$controller
->addExternalJavascript(WT_MODULES_DIR . 'ckeditor/' . self::VERSION . '/ckeditor.js')