From 9cbae43bd05dfa222aeb459501caa148ec197672 Mon Sep 17 00:00:00 2001 From: Grzegorz Rola <grola@seostudio.pl> Date: Sun, 7 Oct 2018 13:08:30 +0200 Subject: [PATCH] PhpDocs refactoring. --- src/WPDesk/Notice/AjaxHandler.php | 3 +++ src/WPDesk/Notice/Factory.php | 2 ++ src/WPDesk/Notice/Notice.php | 2 ++ src/WPDesk/Notice/PermanentDismissibleNotice.php | 2 ++ src/WPDesk/functions.php | 4 ++++ 5 files changed, 13 insertions(+) diff --git a/src/WPDesk/Notice/AjaxHandler.php b/src/WPDesk/Notice/AjaxHandler.php index a452321..577bcc1 100644 --- a/src/WPDesk/Notice/AjaxHandler.php +++ b/src/WPDesk/Notice/AjaxHandler.php @@ -7,6 +7,9 @@ use WPDesk\PluginBuilder\Plugin\PluginAccess; /** * Class AjaxHandler + * + * AjaxHandler for dismissible notices. + * * @package WPDesk\Notice */ class AjaxHandler implements HookablePluginDependant diff --git a/src/WPDesk/Notice/Factory.php b/src/WPDesk/Notice/Factory.php index 2e0430c..2deacf1 100644 --- a/src/WPDesk/Notice/Factory.php +++ b/src/WPDesk/Notice/Factory.php @@ -4,6 +4,8 @@ namespace WPDesk\Notice; /** * Class Factory + * + * Factory for notices. * @package WPDesk\Notice */ class Factory diff --git a/src/WPDesk/Notice/Notice.php b/src/WPDesk/Notice/Notice.php index f385dac..57c774d 100644 --- a/src/WPDesk/Notice/Notice.php +++ b/src/WPDesk/Notice/Notice.php @@ -4,6 +4,8 @@ namespace WPDesk\Notice; /** * Class Notice + * + * WordPress admin notice. * @package WPDesk\Notice */ class Notice diff --git a/src/WPDesk/Notice/PermanentDismissibleNotice.php b/src/WPDesk/Notice/PermanentDismissibleNotice.php index a2e606f..ea31b5a 100644 --- a/src/WPDesk/Notice/PermanentDismissibleNotice.php +++ b/src/WPDesk/Notice/PermanentDismissibleNotice.php @@ -4,6 +4,8 @@ namespace WPDesk\Notice; /** * Class PermanentDismissibleNotice + * + * WordPress admin dismissible notice. * @package WPDesk\Notice */ class PermanentDismissibleNotice extends Notice diff --git a/src/WPDesk/functions.php b/src/WPDesk/functions.php index 74c950c..c7f6dd2 100644 --- a/src/WPDesk/functions.php +++ b/src/WPDesk/functions.php @@ -18,6 +18,8 @@ function WPDeskNotice($noticeContent, $noticeType = 'info', $dismissible = false /** * Creates Notice. * + * Alias for {@see WPDeskNotice()} function. + * * @param string $noticeContent Notice content. * @param string $noticeType Notice type. * @param bool $dismissible Dismissible notice. @@ -47,6 +49,8 @@ function WPDeskPermanentDismissibleNotice($noticeContent, $noticeType = 'info', /** * Creates Permanent Dismissible Notice. * + * Alias for {@see WPDeskPermanentDismissibleNotice()} function. + * * @param string $noticeContent Notice content. * @param string $noticeType Notice type. * @param int $priority Notice priority. -- GitLab