From: Matthias Schmidt Date: Mon, 21 Dec 2015 10:42:22 +0000 (+0100) Subject: Add since tag to PHP documentation X-Git-Tag: 3.0.0_Beta_1~2030^2~207^2~8^2 X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=2f53b086895e926c498dd04a46aef8e80cac71ba;p=GitHub%2FWoltLab%2FWCF.git Add since tag to PHP documentation --- diff --git a/wcfsetup/install/files/lib/acp/form/BoxAddForm.class.php b/wcfsetup/install/files/lib/acp/form/BoxAddForm.class.php index 4dac330518..dfc50927ac 100644 --- a/wcfsetup/install/files/lib/acp/form/BoxAddForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/BoxAddForm.class.php @@ -19,6 +19,7 @@ use wcf\util\StringUtil; * @package com.woltlab.wcf * @subpackage acp.form * @category Community Framework + * @since 2.2 */ class BoxAddForm extends AbstractForm { /** diff --git a/wcfsetup/install/files/lib/acp/form/BoxEditForm.class.php b/wcfsetup/install/files/lib/acp/form/BoxEditForm.class.php index 565fe484d1..5fddd3059d 100644 --- a/wcfsetup/install/files/lib/acp/form/BoxEditForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/BoxEditForm.class.php @@ -16,6 +16,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage acp.form * @category Community Framework + * @since 2.2 */ class BoxEditForm extends BoxAddForm { /** diff --git a/wcfsetup/install/files/lib/acp/form/MenuAddForm.class.php b/wcfsetup/install/files/lib/acp/form/MenuAddForm.class.php index 28904ce6ff..c63717d474 100644 --- a/wcfsetup/install/files/lib/acp/form/MenuAddForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/MenuAddForm.class.php @@ -16,6 +16,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage acp.form * @category Community Framework + * @since 2.2k */ class MenuAddForm extends AbstractForm { /** diff --git a/wcfsetup/install/files/lib/acp/form/MenuEditForm.class.php b/wcfsetup/install/files/lib/acp/form/MenuEditForm.class.php index 447fd8ffc5..cbaf394dc5 100644 --- a/wcfsetup/install/files/lib/acp/form/MenuEditForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/MenuEditForm.class.php @@ -16,6 +16,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage acp.form * @category Community Framework + * @since 2.2 */ class MenuEditForm extends MenuAddForm { /** diff --git a/wcfsetup/install/files/lib/acp/form/MenuItemAddForm.class.php b/wcfsetup/install/files/lib/acp/form/MenuItemAddForm.class.php index 63ddc54295..d8cb577dfd 100644 --- a/wcfsetup/install/files/lib/acp/form/MenuItemAddForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/MenuItemAddForm.class.php @@ -23,6 +23,7 @@ use wcf\util\StringUtil; * @package com.woltlab.wcf * @subpackage acp.form * @category Community Framework + * @since 2.2 */ class MenuItemAddForm extends AbstractForm { /** diff --git a/wcfsetup/install/files/lib/acp/form/MenuItemEditForm.class.php b/wcfsetup/install/files/lib/acp/form/MenuItemEditForm.class.php index a98fe81464..1ac64f0a1a 100644 --- a/wcfsetup/install/files/lib/acp/form/MenuItemEditForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/MenuItemEditForm.class.php @@ -17,6 +17,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage acp.form * @category Community Framework + * @since 2.2 */ class MenuItemEditForm extends MenuItemAddForm { /** diff --git a/wcfsetup/install/files/lib/acp/form/PageAddForm.class.php b/wcfsetup/install/files/lib/acp/form/PageAddForm.class.php index 58e666379d..38be1c0231 100644 --- a/wcfsetup/install/files/lib/acp/form/PageAddForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/PageAddForm.class.php @@ -22,6 +22,7 @@ use wcf\util\StringUtil; * @package com.woltlab.wcf * @subpackage acp.form * @category Community Framework + * @since 2.2 */ class PageAddForm extends AbstractForm { /** diff --git a/wcfsetup/install/files/lib/acp/form/PageEditForm.class.php b/wcfsetup/install/files/lib/acp/form/PageEditForm.class.php index 57596ce863..05d809e798 100644 --- a/wcfsetup/install/files/lib/acp/form/PageEditForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/PageEditForm.class.php @@ -17,6 +17,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage acp.form * @category Community Framework + * @since 2.2 */ class PageEditForm extends PageAddForm { /** diff --git a/wcfsetup/install/files/lib/acp/page/BoxListPage.class.php b/wcfsetup/install/files/lib/acp/page/BoxListPage.class.php index 548c59a5d8..195bf83125 100644 --- a/wcfsetup/install/files/lib/acp/page/BoxListPage.class.php +++ b/wcfsetup/install/files/lib/acp/page/BoxListPage.class.php @@ -11,6 +11,7 @@ use wcf\page\SortablePage; * @package com.woltlab.wcf * @subpackage acp.page * @category Community Framework + * @since 2.2 */ class BoxListPage extends SortablePage { /** diff --git a/wcfsetup/install/files/lib/acp/page/MenuItemListPage.class.php b/wcfsetup/install/files/lib/acp/page/MenuItemListPage.class.php index bfb97a9db2..bfeb379b38 100644 --- a/wcfsetup/install/files/lib/acp/page/MenuItemListPage.class.php +++ b/wcfsetup/install/files/lib/acp/page/MenuItemListPage.class.php @@ -15,6 +15,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage acp.page * @category Community Framework + * @since 2.2 */ class MenuItemListPage extends AbstractPage { /** diff --git a/wcfsetup/install/files/lib/acp/page/MenuListPage.class.php b/wcfsetup/install/files/lib/acp/page/MenuListPage.class.php index 47c57d69f8..11c7d9a79f 100644 --- a/wcfsetup/install/files/lib/acp/page/MenuListPage.class.php +++ b/wcfsetup/install/files/lib/acp/page/MenuListPage.class.php @@ -11,6 +11,7 @@ use wcf\page\SortablePage; * @package com.woltlab.wcf * @subpackage acp.page * @category Community Framework + * @since 2.2 */ class MenuListPage extends SortablePage { /** diff --git a/wcfsetup/install/files/lib/acp/page/PageListPage.class.php b/wcfsetup/install/files/lib/acp/page/PageListPage.class.php index 4b15e9ea2d..7dc654e913 100644 --- a/wcfsetup/install/files/lib/acp/page/PageListPage.class.php +++ b/wcfsetup/install/files/lib/acp/page/PageListPage.class.php @@ -11,6 +11,7 @@ use wcf\page\SortablePage; * @package com.woltlab.wcf * @subpackage acp.page * @category Community Framework + * @since 2.2 */ class PageListPage extends SortablePage { /** diff --git a/wcfsetup/install/files/lib/data/box/Box.class.php b/wcfsetup/install/files/lib/data/box/Box.class.php index f1aed8a92c..b0367dd665 100644 --- a/wcfsetup/install/files/lib/data/box/Box.class.php +++ b/wcfsetup/install/files/lib/data/box/Box.class.php @@ -13,6 +13,7 @@ use wcf\util\StringUtil; * @package com.woltlab.wcf * @subpackage data.box * @category Community Framework + * @since 2.2 */ class Box extends DatabaseObject { /** diff --git a/wcfsetup/install/files/lib/data/box/BoxAction.class.php b/wcfsetup/install/files/lib/data/box/BoxAction.class.php index 6eb628b56a..2f007eb389 100644 --- a/wcfsetup/install/files/lib/data/box/BoxAction.class.php +++ b/wcfsetup/install/files/lib/data/box/BoxAction.class.php @@ -13,6 +13,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.box * @category Community Framework + * @since 2.2 */ class BoxAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/box/BoxEditor.class.php b/wcfsetup/install/files/lib/data/box/BoxEditor.class.php index ffde4765df..a920df8f2d 100644 --- a/wcfsetup/install/files/lib/data/box/BoxEditor.class.php +++ b/wcfsetup/install/files/lib/data/box/BoxEditor.class.php @@ -11,6 +11,7 @@ use wcf\data\DatabaseObjectEditor; * @package com.woltlab.wcf * @subpackage data.box * @category Community Framework + * @since 2.2 */ class BoxEditor extends DatabaseObjectEditor { /** diff --git a/wcfsetup/install/files/lib/data/box/BoxList.class.php b/wcfsetup/install/files/lib/data/box/BoxList.class.php index ca09bcc862..0c4de412c8 100644 --- a/wcfsetup/install/files/lib/data/box/BoxList.class.php +++ b/wcfsetup/install/files/lib/data/box/BoxList.class.php @@ -11,6 +11,7 @@ use wcf\data\DatabaseObjectList; * @package com.woltlab.wcf * @subpackage data.box * @category Community Framework + * @since 2.2 */ class BoxList extends DatabaseObjectList { /** diff --git a/wcfsetup/install/files/lib/data/menu/Menu.class.php b/wcfsetup/install/files/lib/data/menu/Menu.class.php index 843adf481e..ca0c153b14 100644 --- a/wcfsetup/install/files/lib/data/menu/Menu.class.php +++ b/wcfsetup/install/files/lib/data/menu/Menu.class.php @@ -12,6 +12,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.menu * @category Community Framework + * @since 2.2 */ class Menu extends DatabaseObject { /** diff --git a/wcfsetup/install/files/lib/data/menu/MenuAction.class.php b/wcfsetup/install/files/lib/data/menu/MenuAction.class.php index 3c0b300e95..644100d287 100644 --- a/wcfsetup/install/files/lib/data/menu/MenuAction.class.php +++ b/wcfsetup/install/files/lib/data/menu/MenuAction.class.php @@ -12,6 +12,7 @@ use wcf\system\exception\PermissionDeniedException; * @package com.woltlab.wcf * @subpackage data.menu * @category Community Framework + * @since 2.2 */ class MenuAction extends AbstractDatabaseObjectAction { /** diff --git a/wcfsetup/install/files/lib/data/menu/MenuEditor.class.php b/wcfsetup/install/files/lib/data/menu/MenuEditor.class.php index e285bce55a..a234350116 100644 --- a/wcfsetup/install/files/lib/data/menu/MenuEditor.class.php +++ b/wcfsetup/install/files/lib/data/menu/MenuEditor.class.php @@ -13,6 +13,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.menu * @category Community Framework + * @since 2.2 */ class MenuEditor extends DatabaseObjectEditor { /** diff --git a/wcfsetup/install/files/lib/data/menu/MenuList.class.php b/wcfsetup/install/files/lib/data/menu/MenuList.class.php index 373ac440d7..0cc8df6525 100644 --- a/wcfsetup/install/files/lib/data/menu/MenuList.class.php +++ b/wcfsetup/install/files/lib/data/menu/MenuList.class.php @@ -11,6 +11,7 @@ use wcf\data\DatabaseObjectList; * @package com.woltlab.wcf * @subpackage data.menu * @category Community Framework + * @since 2.2 */ class MenuList extends DatabaseObjectList { /** diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php index bb2efb4ad1..7aac56977e 100644 --- a/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php +++ b/wcfsetup/install/files/lib/data/menu/item/MenuItem.class.php @@ -12,6 +12,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.menu.item * @category Community Framework + * @since 2.2 */ class MenuItem extends DatabaseObject { /** diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php index dfe886c71a..1e820a031a 100644 --- a/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php +++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php @@ -13,6 +13,7 @@ use wcf\system\exception\PermissionDeniedException; * @package com.woltlab.wcf * @subpackage data.menu.item * @category Community Framework + * @since 2.2 */ class MenuItemAction extends AbstractDatabaseObjectAction implements IToggleAction { /** diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemEditor.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemEditor.class.php index e9d7b0c6b4..4bf02368bf 100644 --- a/wcfsetup/install/files/lib/data/menu/item/MenuItemEditor.class.php +++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemEditor.class.php @@ -13,6 +13,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.menu.item * @category Community Framework + * @since 2.2 */ class MenuItemEditor extends DatabaseObjectEditor { /** diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemList.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemList.class.php index e9283238e0..6707ac4cce 100644 --- a/wcfsetup/install/files/lib/data/menu/item/MenuItemList.class.php +++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemList.class.php @@ -11,6 +11,7 @@ use wcf\data\DatabaseObjectList; * @package com.woltlab.wcf * @subpackage data.menu.item * @category Community Framework + * @since 2.2 */ class MenuItemList extends DatabaseObjectList { /** diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemNode.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemNode.class.php index 1179ab679f..e8a1b51529 100644 --- a/wcfsetup/install/files/lib/data/menu/item/MenuItemNode.class.php +++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemNode.class.php @@ -10,6 +10,7 @@ namespace wcf\data\menu\item; * @package com.woltlab.wcf * @subpackage data.menu.item * @category Community Framework + * @since 2.2 */ class MenuItemNode implements \Countable, \RecursiveIterator { /** diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemNodeTree.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemNodeTree.class.php index ab4aee7458..0306aec182 100644 --- a/wcfsetup/install/files/lib/data/menu/item/MenuItemNodeTree.class.php +++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemNodeTree.class.php @@ -10,6 +10,7 @@ namespace wcf\data\menu\item; * @package com.woltlab.wcf * @subpackage data.menu.item * @category Community Framework + * @since 2.2 */ class MenuItemNodeTree { /** diff --git a/wcfsetup/install/files/lib/data/page/Page.class.php b/wcfsetup/install/files/lib/data/page/Page.class.php index 4bdab514fa..453ffa3c1b 100644 --- a/wcfsetup/install/files/lib/data/page/Page.class.php +++ b/wcfsetup/install/files/lib/data/page/Page.class.php @@ -13,6 +13,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.page * @category Community Framework + * @since 2.2 */ class Page extends DatabaseObject { /** diff --git a/wcfsetup/install/files/lib/data/page/PageAction.class.php b/wcfsetup/install/files/lib/data/page/PageAction.class.php index 2d8c452410..7213fea440 100644 --- a/wcfsetup/install/files/lib/data/page/PageAction.class.php +++ b/wcfsetup/install/files/lib/data/page/PageAction.class.php @@ -14,6 +14,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage data.page * @category Community Framework + * @since 2.2 */ class PageAction extends AbstractDatabaseObjectAction implements IToggleAction { /** diff --git a/wcfsetup/install/files/lib/data/page/PageEditor.class.php b/wcfsetup/install/files/lib/data/page/PageEditor.class.php index 3893d31d57..5bba637b86 100644 --- a/wcfsetup/install/files/lib/data/page/PageEditor.class.php +++ b/wcfsetup/install/files/lib/data/page/PageEditor.class.php @@ -11,6 +11,7 @@ use wcf\data\DatabaseObjectEditor; * @package com.woltlab.wcf * @subpackage data.page * @category Community Framework + * @since 2.2 */ class PageEditor extends DatabaseObjectEditor { /** diff --git a/wcfsetup/install/files/lib/data/page/PageList.class.php b/wcfsetup/install/files/lib/data/page/PageList.class.php index c64326bca4..d3f9f65342 100644 --- a/wcfsetup/install/files/lib/data/page/PageList.class.php +++ b/wcfsetup/install/files/lib/data/page/PageList.class.php @@ -11,6 +11,7 @@ use wcf\data\DatabaseObjectList; * @package com.woltlab.wcf * @subpackage data.page * @category Community Framework + * @since 2.2 */ class PageList extends DatabaseObjectList { /** diff --git a/wcfsetup/install/files/lib/data/page/PageNode.class.php b/wcfsetup/install/files/lib/data/page/PageNode.class.php index 33017b298c..21ebd52bb1 100644 --- a/wcfsetup/install/files/lib/data/page/PageNode.class.php +++ b/wcfsetup/install/files/lib/data/page/PageNode.class.php @@ -10,6 +10,7 @@ namespace wcf\data\page; * @package com.woltlab.wcf * @subpackage data.page * @category Community Framework + * @since 2.2 */ class PageNode implements \Countable, \RecursiveIterator { /** diff --git a/wcfsetup/install/files/lib/data/page/PageNodeTree.class.php b/wcfsetup/install/files/lib/data/page/PageNodeTree.class.php index bbb6c99a1c..81a9daca32 100644 --- a/wcfsetup/install/files/lib/data/page/PageNodeTree.class.php +++ b/wcfsetup/install/files/lib/data/page/PageNodeTree.class.php @@ -10,6 +10,7 @@ namespace wcf\data\page; * @package com.woltlab.wcf * @subpackage data.page * @category Community Framework + * @since 2.2 */ class PageNodeTree { /** diff --git a/wcfsetup/install/files/lib/page/CmsPage.class.php b/wcfsetup/install/files/lib/page/CmsPage.class.php index 8e5456e9d3..6ec6304cc3 100644 --- a/wcfsetup/install/files/lib/page/CmsPage.class.php +++ b/wcfsetup/install/files/lib/page/CmsPage.class.php @@ -15,6 +15,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage page * @category Community Framework + * @since 2.2 */ class CmsPage extends AbstractPage { /** diff --git a/wcfsetup/install/files/lib/system/WCF.class.php b/wcfsetup/install/files/lib/system/WCF.class.php index 1bc4788a23..4695e8e78b 100644 --- a/wcfsetup/install/files/lib/system/WCF.class.php +++ b/wcfsetup/install/files/lib/system/WCF.class.php @@ -813,6 +813,7 @@ class WCF { * Returns box handler. * * @return BoxHandler + * @since 2.2 */ public function getBoxHandler() { return BoxHandler::getInstance(); diff --git a/wcfsetup/install/files/lib/system/WCFSetup.class.php b/wcfsetup/install/files/lib/system/WCFSetup.class.php index 2834a832e4..a2f0d8a9af 100644 --- a/wcfsetup/install/files/lib/system/WCFSetup.class.php +++ b/wcfsetup/install/files/lib/system/WCFSetup.class.php @@ -159,6 +159,8 @@ class WCFSetup extends WCF { /** * Gets the selected wcf dir from request. + * + * @since 2.2 */ protected static function getInstallationDirectories() { if (self::$developerMode && isset($_ENV['WCFSETUP_USEDEFAULTWCFDIR'])) { @@ -457,6 +459,8 @@ class WCFSetup extends WCF { /** * Searches the wcf dir. + * + * @since 2.2 */ protected function configureDirectories() { // get available packages diff --git a/wcfsetup/install/files/lib/system/application/ApplicationHandler.class.php b/wcfsetup/install/files/lib/system/application/ApplicationHandler.class.php index 137a0186f4..44930f76b7 100644 --- a/wcfsetup/install/files/lib/system/application/ApplicationHandler.class.php +++ b/wcfsetup/install/files/lib/system/application/ApplicationHandler.class.php @@ -80,6 +80,7 @@ class ApplicationHandler extends SingletonFactory { * * @param integer $packageID package id * @return Application application object + * @since 2.2 */ public function getApplicationByID($packageID) { if (isset($this->cache['application'][$packageID])) { diff --git a/wcfsetup/install/files/lib/system/box/BoxHandler.class.php b/wcfsetup/install/files/lib/system/box/BoxHandler.class.php index fd4a852c23..dfabcb45e7 100644 --- a/wcfsetup/install/files/lib/system/box/BoxHandler.class.php +++ b/wcfsetup/install/files/lib/system/box/BoxHandler.class.php @@ -12,6 +12,7 @@ use wcf\system\SingletonFactory; * @package com.woltlab.wcf * @subpackage system.box * @category Community Framework + * @since 2.2 */ class BoxHandler extends SingletonFactory { /** diff --git a/wcfsetup/install/files/lib/system/cache/builder/RoutingCacheBuilder.class.php b/wcfsetup/install/files/lib/system/cache/builder/RoutingCacheBuilder.class.php index 6dd4523bfb..089c1942f6 100644 --- a/wcfsetup/install/files/lib/system/cache/builder/RoutingCacheBuilder.class.php +++ b/wcfsetup/install/files/lib/system/cache/builder/RoutingCacheBuilder.class.php @@ -14,6 +14,7 @@ use wcf\util\FileUtil; * @package com.woltlab.wcf * @subpackage system.cache.builder * @category Community Framework + * @since 2.2 */ class RoutingCacheBuilder extends AbstractCacheBuilder { /** diff --git a/wcfsetup/install/files/lib/system/html/input/HtmlInputProcessor.class.php b/wcfsetup/install/files/lib/system/html/input/HtmlInputProcessor.class.php index 73408a0e80..53a13dc2dd 100644 --- a/wcfsetup/install/files/lib/system/html/input/HtmlInputProcessor.class.php +++ b/wcfsetup/install/files/lib/system/html/input/HtmlInputProcessor.class.php @@ -4,6 +4,10 @@ use wcf\system\html\input\filter\IHtmlInputFilter; use wcf\system\html\input\filter\MessageHtmlInputFilter; use wcf\system\html\input\node\HtmlInputNodeProcessor; +/** + * TOOD documentation + * @since 2.2 + */ class HtmlInputProcessor { /** * @var IHtmlInputFilter diff --git a/wcfsetup/install/files/lib/system/html/input/filter/IHtmlInputFilter.class.php b/wcfsetup/install/files/lib/system/html/input/filter/IHtmlInputFilter.class.php index f30d84fe4e..be1ceb60b4 100644 --- a/wcfsetup/install/files/lib/system/html/input/filter/IHtmlInputFilter.class.php +++ b/wcfsetup/install/files/lib/system/html/input/filter/IHtmlInputFilter.class.php @@ -1,6 +1,10 @@ getDocument()->getElementsByTagName('blockquote'); diff --git a/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeWoltlabMention.class.php b/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeWoltlabMention.class.php index e92c466170..cb3dd4481c 100644 --- a/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeWoltlabMention.class.php +++ b/wcfsetup/install/files/lib/system/html/output/node/HtmlOutputNodeWoltlabMention.class.php @@ -6,6 +6,10 @@ use wcf\system\html\output\HtmlOutputNodeProcessor; use wcf\system\WCF; use wcf\util\StringUtil; +/** + * TOOD documentation + * @since 2.2 + */ class HtmlOutputNodeWoltlabMention implements IHtmlOutputNode { /** * @var UserProfile[] diff --git a/wcfsetup/install/files/lib/system/html/output/node/IHtmlOutputNode.class.php b/wcfsetup/install/files/lib/system/html/output/node/IHtmlOutputNode.class.php index d64220df32..b3bd23c7a6 100644 --- a/wcfsetup/install/files/lib/system/html/output/node/IHtmlOutputNode.class.php +++ b/wcfsetup/install/files/lib/system/html/output/node/IHtmlOutputNode.class.php @@ -2,6 +2,10 @@ namespace wcf\system\html\output\node; use wcf\system\html\output\HtmlOutputNodeProcessor; +/** + * TOOD documentation + * @since 2.2 + */ interface IHtmlOutputNode { public function process(HtmlOutputNodeProcessor $htmlOutputNodeProcessor); diff --git a/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php b/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php index d2cd5fca36..649d435043 100644 --- a/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php +++ b/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php @@ -241,7 +241,8 @@ class LanguageFactory extends SingletonFactory { /** * Returns the default language object. * - * @return Language + * @return Language + * @since 2.2 */ public function getDefaultLanguage() { return $this->getLanguage($this->cache['default']); diff --git a/wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php index 06f5bf3722..2f8d820705 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/AbstractXMLPackageInstallationPlugin.class.php @@ -191,9 +191,10 @@ abstract class AbstractXMLPackageInstallationPlugin extends AbstractPackageInsta * Returns i18n values by validating each value against the list of installed * languages, optionally returning only the best matching value. * - * @param string[] $values list of values by language code - * @param boolean $singleValueOnly true to return only the best matching value - * @return string[]|string matching i18n values controller by `$singleValueOnly` + * @param string[] $values list of values by language code + * @param boolean $singleValueOnly true to return only the best matching value + * @return string[]|string matching i18n values controller by `$singleValueOnly` + * @since 2.2 */ protected function getI18nValues(array $values, $singleValueOnly = false) { if (empty($values)) { diff --git a/wcfsetup/install/files/lib/system/package/plugin/MenuItemPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/MenuItemPackageInstallationPlugin.class.php index 1f946aa6c6..61bfc1bc07 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/MenuItemPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/MenuItemPackageInstallationPlugin.class.php @@ -14,6 +14,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage acp.package.plugin * @category Community Framework + * @since 2.2 */ class MenuItemPackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin { /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/MenuPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/MenuPackageInstallationPlugin.class.php index 9bb9e0f3dc..b97c2ed4b3 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/MenuPackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/MenuPackageInstallationPlugin.class.php @@ -14,6 +14,7 @@ use wcf\system\WCF; * @package com.woltlab.wcf * @subpackage acp.package.plugin * @category Community Framework + * @since 2.2 */ class MenuPackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin { /** diff --git a/wcfsetup/install/files/lib/system/package/plugin/PagePackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/PagePackageInstallationPlugin.class.php index cdd33f2370..f6a952177d 100644 --- a/wcfsetup/install/files/lib/system/package/plugin/PagePackageInstallationPlugin.class.php +++ b/wcfsetup/install/files/lib/system/package/plugin/PagePackageInstallationPlugin.class.php @@ -16,6 +16,7 @@ use wcf\util\StringUtil; * @package com.woltlab.wcf * @subpackage acp.package.plugin * @category Community Framework + * @since 2.2 */ class PagePackageInstallationPlugin extends AbstractXMLPackageInstallationPlugin { /** diff --git a/wcfsetup/install/files/lib/system/request/CmsLinkHandler.class.php b/wcfsetup/install/files/lib/system/request/CmsLinkHandler.class.php index 08c95dd734..fd160674d2 100644 --- a/wcfsetup/install/files/lib/system/request/CmsLinkHandler.class.php +++ b/wcfsetup/install/files/lib/system/request/CmsLinkHandler.class.php @@ -2,6 +2,10 @@ namespace wcf\system\request; use wcf\system\SingletonFactory; +/** + * TODO: documentation + * @since 2.2 + */ class CmsLinkHandler extends SingletonFactory { public function getLink($pageID, $languageID = -1) { return LinkHandler::getInstance()->getLink('Cms', [ diff --git a/wcfsetup/install/files/lib/system/request/ControllerMap.class.php b/wcfsetup/install/files/lib/system/request/ControllerMap.class.php index 1bf707e48d..d95ca676ce 100644 --- a/wcfsetup/install/files/lib/system/request/ControllerMap.class.php +++ b/wcfsetup/install/files/lib/system/request/ControllerMap.class.php @@ -14,6 +14,7 @@ use wcf\system\SingletonFactory; * @package com.woltlab.wcf * @subpackage system.request * @category Community Framework + * @since 2.2 */ class ControllerMap extends SingletonFactory { /** diff --git a/wcfsetup/install/files/lib/system/request/LinkHandler.class.php b/wcfsetup/install/files/lib/system/request/LinkHandler.class.php index 5f7306fc45..141debaaa6 100644 --- a/wcfsetup/install/files/lib/system/request/LinkHandler.class.php +++ b/wcfsetup/install/files/lib/system/request/LinkHandler.class.php @@ -224,10 +224,11 @@ class LinkHandler extends SingletonFactory { * Passing in an illegal page id will cause this method to fail silently, returning an * empty string. * - * @param integer $pageID page id - * @param integer $languageID language id, optional - * @return string full URL of empty string if `$pageID` is invalid - * @throws \wcf\system\exception\SystemException + * @param integer $pageID page id + * @param integer $languageID language id, optional + * @return string full URL of empty string if `$pageID` is invalid + * @throws \wcf\system\exception\SystemException + * @since 2.2 */ public function getCmsLink($pageID, $languageID = -1) { // use current language diff --git a/wcfsetup/install/files/lib/system/request/Request.class.php b/wcfsetup/install/files/lib/system/request/Request.class.php index 35fb4d4f54..eee94c01e2 100644 --- a/wcfsetup/install/files/lib/system/request/Request.class.php +++ b/wcfsetup/install/files/lib/system/request/Request.class.php @@ -88,7 +88,8 @@ class Request { /** * Returns request meta data. * - * @return string[] + * @return string[] + * @since 2.2 */ public function getMetaData() { return $this->metaData; diff --git a/wcfsetup/install/files/lib/system/request/RouteHandler.class.php b/wcfsetup/install/files/lib/system/request/RouteHandler.class.php index 85b60aeac4..53adfae66d 100644 --- a/wcfsetup/install/files/lib/system/request/RouteHandler.class.php +++ b/wcfsetup/install/files/lib/system/request/RouteHandler.class.php @@ -206,8 +206,9 @@ class RouteHandler extends SingletonFactory { * This heavily limits the abilities for end-users to define appealing urls, but at * the same time this ensures a sufficient level of stability. * - * @param string $customUrl url to perform sanitiy checks on - * @return bool true if `$customUrl` passes the sanity check + * @param string $customUrl url to perform sanitiy checks on + * @return bool true if `$customUrl` passes the sanity check + * @since 2.2 */ public static function isValidCustomUrl($customUrl) { return preg_match('~^[a-zA-Z0-9\-_/]+$~', $customUrl) === 1; diff --git a/wcfsetup/install/files/lib/system/request/route/DynamicRequestRoute.class.php b/wcfsetup/install/files/lib/system/request/route/DynamicRequestRoute.class.php index e6f5963bb2..778778dc00 100644 --- a/wcfsetup/install/files/lib/system/request/route/DynamicRequestRoute.class.php +++ b/wcfsetup/install/files/lib/system/request/route/DynamicRequestRoute.class.php @@ -15,6 +15,7 @@ use wcf\system\request\RouteHandler; * @package com.woltlab.wcf * @subpackage system.request * @category Community Framework + * @since 2.2 */ class DynamicRequestRoute implements IRequestRoute { /** diff --git a/wcfsetup/install/files/lib/system/request/route/IRequestRoute.class.php b/wcfsetup/install/files/lib/system/request/route/IRequestRoute.class.php index d1a37eb487..0ff0adc606 100644 --- a/wcfsetup/install/files/lib/system/request/route/IRequestRoute.class.php +++ b/wcfsetup/install/files/lib/system/request/route/IRequestRoute.class.php @@ -11,6 +11,7 @@ use wcf\system\request\IRoute; * @package com.woltlab.wcf * @subpackage system.request * @category Community Framework + * @since 2.2 */ interface IRequestRoute extends IRoute { /** diff --git a/wcfsetup/install/files/lib/system/request/route/LookupRequestRoute.class.php b/wcfsetup/install/files/lib/system/request/route/LookupRequestRoute.class.php index e8eeb5dff1..b42c1b6b83 100644 --- a/wcfsetup/install/files/lib/system/request/route/LookupRequestRoute.class.php +++ b/wcfsetup/install/files/lib/system/request/route/LookupRequestRoute.class.php @@ -15,6 +15,7 @@ use wcf\util\FileUtil; * @package com.woltlab.wcf * @subpackage system.request * @category Community Framework + * @since 2.2 */ class LookupRequestRoute implements IRequestRoute { /** diff --git a/wcfsetup/install/files/lib/system/request/route/StaticRequestRoute.class.php b/wcfsetup/install/files/lib/system/request/route/StaticRequestRoute.class.php index 1fc6958f88..ce8baa6fb9 100644 --- a/wcfsetup/install/files/lib/system/request/route/StaticRequestRoute.class.php +++ b/wcfsetup/install/files/lib/system/request/route/StaticRequestRoute.class.php @@ -11,6 +11,7 @@ use wcf\system\request\ControllerMap; * @package com.woltlab.wcf * @subpackage system.request * @category Community Framework + * @since 2.2 */ class StaticRequestRoute extends DynamicRequestRoute { /** diff --git a/wcfsetup/install/files/lib/system/template/plugin/PageBlockTemplatePlugin.class.php b/wcfsetup/install/files/lib/system/template/plugin/PageBlockTemplatePlugin.class.php index b67c8317f6..1446d01907 100644 --- a/wcfsetup/install/files/lib/system/template/plugin/PageBlockTemplatePlugin.class.php +++ b/wcfsetup/install/files/lib/system/template/plugin/PageBlockTemplatePlugin.class.php @@ -33,6 +33,7 @@ use wcf\system\template\TemplateEngine; * @package com.woltlab.wcf * @subpackage system.template.plugin * @category Community Framework + * @since 2.2 */ class PageBlockTemplatePlugin implements IBlockTemplatePlugin { /**