From 7644950b48b094bfe5675348aefb7cf5747d325b Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Thu, 16 Apr 2015 17:00:08 +0200 Subject: Add @since tags to all methods in public namespace * enhance the app development experience - you can look up the method introduction right inside the code without searching via git blame * easier to write apps for multiple versions --- lib/public/activity/iconsumer.php | 7 +++++++ lib/public/activity/iextension.php | 16 ++++++++++++++++ lib/public/activity/imanager.php | 20 ++++++++++++++++++++ 3 files changed, 43 insertions(+) (limited to 'lib/public/activity') diff --git a/lib/public/activity/iconsumer.php b/lib/public/activity/iconsumer.php index 97adc8a3ba0..a55110ababc 100644 --- a/lib/public/activity/iconsumer.php +++ b/lib/public/activity/iconsumer.php @@ -29,6 +29,12 @@ // This means that they should be used by apps instead of the internal ownCloud classes namespace OCP\Activity; +/** + * Interface IConsumer + * + * @package OCP\Activity + * @since 6.0.0 + */ interface IConsumer { /** * @param $app @@ -42,6 +48,7 @@ interface IConsumer { * @param $type * @param $priority * @return mixed + * @since 6.0.0 */ function receive($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority ); } diff --git a/lib/public/activity/iextension.php b/lib/public/activity/iextension.php index 499fc90f7ca..19d1d2e83a0 100644 --- a/lib/public/activity/iextension.php +++ b/lib/public/activity/iextension.php @@ -31,6 +31,12 @@ // This means that they should be used by apps instead of the internal ownCloud classes namespace OCP\Activity; +/** + * Interface IExtension + * + * @package OCP\Activity + * @since 8.0.0 + */ interface IExtension { const PRIORITY_VERYLOW = 10; @@ -45,6 +51,7 @@ interface IExtension { * * @param string $languageCode * @return array|false + * @since 8.0.0 */ public function getNotificationTypes($languageCode); @@ -54,6 +61,7 @@ interface IExtension { * * @param string $method * @return array|false + * @since 8.0.0 */ public function getDefaultTypes($method); @@ -63,6 +71,7 @@ interface IExtension { * * @param string $type * @return string|false + * @since 8.0.0 */ public function getTypeIcon($type); @@ -77,6 +86,7 @@ interface IExtension { * @param boolean $highlightParams * @param string $languageCode * @return string|false + * @since 8.0.0 */ public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); @@ -90,6 +100,7 @@ interface IExtension { * @param string $app * @param string $text * @return array|false + * @since 8.0.0 */ public function getSpecialParameterList($app, $text); @@ -99,6 +110,7 @@ interface IExtension { * * @param array $activity * @return integer|false + * @since 8.0.0 */ public function getGroupParameter($activity); @@ -108,6 +120,7 @@ interface IExtension { * If no further entries are to be added false is no be returned. * * @return array|false + * @since 8.0.0 */ public function getNavigation(); @@ -116,6 +129,7 @@ interface IExtension { * * @param string $filterValue * @return boolean + * @since 8.0.0 */ public function isFilterValid($filterValue); @@ -126,6 +140,7 @@ interface IExtension { * @param array $types * @param string $filter * @return array|false + * @since 8.0.0 */ public function filterNotificationTypes($types, $filter); @@ -137,6 +152,7 @@ interface IExtension { * * @param string $filter * @return array|false + * @since 8.0.0 */ public function getQueryForFilter($filter); } diff --git a/lib/public/activity/imanager.php b/lib/public/activity/imanager.php index 2e55c8b45b2..cadb37da03b 100644 --- a/lib/public/activity/imanager.php +++ b/lib/public/activity/imanager.php @@ -31,6 +31,12 @@ // This means that they should be used by apps instead of the internal ownCloud classes namespace OCP\Activity; +/** + * Interface IManager + * + * @package OCP\Activity + * @since 6.0.0 + */ interface IManager { /** @@ -45,6 +51,7 @@ interface IManager { * @param $type * @param $priority * @return mixed + * @since 6.0.0 */ function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority); @@ -56,6 +63,7 @@ interface IManager { * * @param \Closure $callable * @return void + * @since 6.0.0 */ function registerConsumer(\Closure $callable); @@ -67,6 +75,7 @@ interface IManager { * * @param \Closure $callable * @return void + * @since 8.0.0 */ function registerExtension(\Closure $callable); @@ -74,18 +83,21 @@ interface IManager { * Will return additional notification types as specified by other apps * @param string $languageCode * @return array + * @since 8.0.0 */ function getNotificationTypes($languageCode); /** * @param string $method * @return array + * @since 8.0.0 */ function getDefaultTypes($method); /** * @param string $type * @return string + * @since 8.0.0 */ function getTypeIcon($type); @@ -97,6 +109,7 @@ interface IManager { * @param boolean $highlightParams * @param string $languageCode * @return string|false + * @since 8.0.0 */ function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode); @@ -104,23 +117,27 @@ interface IManager { * @param string $app * @param string $text * @return array|false + * @since 8.0.0 */ function getSpecialParameterList($app, $text); /** * @param array $activity * @return integer|false + * @since 8.0.0 */ function getGroupParameter($activity); /** * @return array + * @since 8.0.0 */ function getNavigation(); /** * @param string $filterValue * @return boolean + * @since 8.0.0 */ function isFilterValid($filterValue); @@ -128,12 +145,14 @@ interface IManager { * @param array $types * @param string $filter * @return array + * @since 8.0.0 */ function filterNotificationTypes($types, $filter); /** * @param string $filter * @return array + * @since 8.0.0 */ function getQueryForFilter($filter); @@ -144,6 +163,7 @@ interface IManager { * * @return string * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique + * @since 8.1.0 */ public function getCurrentUserId(); } -- cgit v1.2.3