Helper documentation for info plugin

zioth · Dec 23, 2018 · 9e2add7 · 9e2add7
1 parent b7bccb0
commit 9e2add7
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/helper.php b/helper.php
@@ -15,6 +15,42 @@ public function __construct() {
 	}
 
 
+	/**
+	 * Return methods of this helper
+	 *
+	 * @return array with methods description
+	 */
+	function getMethods() {
+		$result = array();
+		$result[] = array(
+			'name' => 'forText',
+			'desc' => 'Manually construct a tooltip',
+			'params' => array(
+				'content' => 'string',
+				'tooltip' => 'string',
+				'title (optional)' => 'string',
+				'preTitle (optional)' => 'string',
+				'classes (optional)' => 'string',
+				'textStyles (optional)' => 'string',
+			),
+			'return' => array('result' => 'string')
+		);
+		$result[] = array(
+			'name' => 'forWikilink',
+			'desc' => 'Generate a tooltip from a wikilink',
+			'params' => array(
+				'id' => 'string',
+				'content (optional)' => 'string',
+				'preTitle (optional)' => 'string',
+				'classes (optional)' => 'string',
+				'textStyles (optional)' => 'string',
+			),
+			'return' => array('result' => 'string')
+		);
+		return $result;
+	}
+
+
 	/**
 	 * Return a simple tooltip.
 	 *