Add docblocks to sample events code

iMattPro · iMattPro · commit f03915c06e13 · 2016-04-03T08:49:59.000-07:00
diff --git a/skeleton/event/main_listener.php.tpl b/skeleton/event/main_listener.php.tpl
@@ -70,6 +70,11 @@ class main_listener implements EventSubscriberInterface
 <!-- ENDIF -->
 <!-- IF COMPONENT.controller -->
 
+	/**
+	* Load common language files during user setup
+	*
+	* @param \phpbb\event\data	$event	Event object
+	*/
 	public function load_language_on_setup($event)
 	{
 		$lang_set_ext = $event['lang_set_ext'];
@@ -80,6 +85,9 @@ class main_listener implements EventSubscriberInterface
 		$event['lang_set_ext'] = $lang_set_ext;
 	}
 
+	/**
+	* Add a link to the controller in the forum navbar
+	*/
 	public function add_page_header_link($event)
 	{
 		$this->template->assign_vars(array(

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,11 @@ class main_listener implements EventSubscriberInterface`
`70`	`70`	`<!-- ENDIF -->`
`71`	`71`	`<!-- IF COMPONENT.controller -->`
`72`	`72`
	`73`	`+ /**`
	`74`	`+ * Load common language files during user setup`
	`75`	`+ *`
	`76`	`+ * @param \phpbb\event\data $event Event object`
	`77`	`+ */`
`73`	`78`	`public function load_language_on_setup($event)`
`74`	`79`	`{`
`75`	`80`	`$lang_set_ext = $event['lang_set_ext'];`
`@@ -80,6 +85,9 @@ class main_listener implements EventSubscriberInterface`
`80`	`85`	`$event['lang_set_ext'] = $lang_set_ext;`
`81`	`86`	`}`
`82`	`87`
	`88`	`+ /**`
	`89`	`+ * Add a link to the controller in the forum navbar`
	`90`	`+ */`
`83`	`91`	`public function add_page_header_link($event)`
`84`	`92`	`{`
`85`	`93`	`$this->template->assign_vars(array(`