summaryrefslogtreecommitdiff
path: root/library/WT/Module
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@gmail.com>2014-10-18 16:58:32 +0100
committerGreg Roach <fisharebest@gmail.com>2014-10-18 16:58:32 +0100
commitc3977ece291ed2fa2ccd0a2e0ad91780a62131c1 (patch)
tree521321db8a5a6d691d7df16bab5e65d1cc837767 /library/WT/Module
parentd2f5f6d2a2dc8e2be0a4da0006c6a73f51af8443 (diff)
downloadwebtrees-c3977ece291ed2fa2ccd0a2e0ad91780a62131c1.tar.gz
webtrees-c3977ece291ed2fa2ccd0a2e0ad91780a62131c1.tar.bz2
webtrees-c3977ece291ed2fa2ccd0a2e0ad91780a62131c1.zip
PHPDoc
Diffstat (limited to 'library/WT/Module')
-rw-r--r--library/WT/Module/Block.php12
-rw-r--r--library/WT/Module/Menu.php2
-rw-r--r--library/WT/Module/Sidebar.php4
-rw-r--r--library/WT/Module/Tab.php8
4 files changed, 13 insertions, 13 deletions
diff --git a/library/WT/Module/Block.php b/library/WT/Module/Block.php
index 098713acb3..f377e54aa5 100644
--- a/library/WT/Module/Block.php
+++ b/library/WT/Module/Block.php
@@ -22,7 +22,7 @@ interface WT_Module_Block {
/**
* Generate the HTML content of this block.
*
- * @param int $block_id
+ * @param integer $block_id
*
* @return string
*/
@@ -33,30 +33,30 @@ interface WT_Module_Block {
* Simple blocks are faster in-line, more comples ones
* can be loaded later.
*
- * @return bool
+ * @return boolean
*/
public function loadAjax();
/**
* Can this block be shown on the user’s home page?
*
- * @return bool
+ * @return boolean
*/
public function isUserBlock();
/**
* Can this block be shown on the tree’s home page?
*
- * @return bool
+ * @return boolean
*/
public function isGedcomBlock();
/**
* An HTML form to edit block settings
*
- * @param int $block_id
+ * @param integer $block_id
*
- * @return mixed
+ * @return void
*/
public function configureBlock($block_id);
}
diff --git a/library/WT/Module/Menu.php b/library/WT/Module/Menu.php
index 9916a5d988..8cfb4d6e4e 100644
--- a/library/WT/Module/Menu.php
+++ b/library/WT/Module/Menu.php
@@ -22,7 +22,7 @@ interface WT_Module_Menu {
/**
* The user can re-order menus. Until they do, they are shown in this order.
*
- * @return int
+ * @return integer
*/
public function defaultMenuOrder();
}
diff --git a/library/WT/Module/Sidebar.php b/library/WT/Module/Sidebar.php
index 35cc6614bf..a5841f0934 100644
--- a/library/WT/Module/Sidebar.php
+++ b/library/WT/Module/Sidebar.php
@@ -22,7 +22,7 @@ interface WT_Module_Sidebar {
/**
* The user can change the order of sidebars. Until they do this, they are shown in this order.
*
- * @return int
+ * @return integer
*/
public function defaultSidebarOrder();
@@ -42,7 +42,7 @@ interface WT_Module_Sidebar {
/**
* Does this sidebar have anything to display for this individual?
*
- * @return bool
+ * @return boolean
*/
public function hasSidebarContent();
}
diff --git a/library/WT/Module/Tab.php b/library/WT/Module/Tab.php
index 6476c09917..e46173eee9 100644
--- a/library/WT/Module/Tab.php
+++ b/library/WT/Module/Tab.php
@@ -23,7 +23,7 @@ interface WT_Module_Tab {
* The user can re-arrange the tab order, but until they do, this
* is the order in which tabs are shown.
*
- * @return int
+ * @return integer
*/
public function defaultTabOrder();
@@ -36,14 +36,14 @@ interface WT_Module_Tab {
/**
* Is this tab empty? If so, we don't always need to display it.
- * @return bool
+ * @return boolean
*/
public function hasTabContent();
/**
* Can this tab load asynchronously?
*
- * @return bool
+ * @return boolean
*/
public function canLoadAjax();
@@ -60,7 +60,7 @@ interface WT_Module_Tab {
* A greyed out tab has no actual content, but may perhaps have
* options to create content.
*
- * @return bool
+ * @return boolean
*/
public function isGrayedOut();
}