From b416f7d8acabebec94e771394b9e3d69c69cadd5 Mon Sep 17 00:00:00 2001 From: Bernhard Reiter Date: Mon, 13 Oct 2014 23:12:18 +0200 Subject: [PATCH] PHPDoc fixes as suggested by @MorrisJobke. --- lib/private/tagging/tag.php | 4 ++++ lib/private/tagging/tagmapper.php | 2 +- lib/private/tags.php | 4 ++-- lib/public/itags.php | 4 ++-- 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/private/tagging/tag.php b/lib/private/tagging/tag.php index d0cd6bbb96..3ea9fbac20 100644 --- a/lib/private/tagging/tag.php +++ b/lib/private/tagging/tag.php @@ -55,8 +55,11 @@ class Tag extends Entity { /** * Transform a database columnname to a property + * * @param string $columnName the name of the column * @return string the property name + * @todo migrate existing database columns to the correct names + * to be able to drop this direct mapping */ public function columnToProperty($columnName){ if ($columnName === 'category') { @@ -70,6 +73,7 @@ class Tag extends Entity { /** * Transform a property to a database column name + * * @param string $property the name of the property * @return string the column name */ diff --git a/lib/private/tagging/tagmapper.php b/lib/private/tagging/tagmapper.php index b5929e2618..6c9bec7aa5 100644 --- a/lib/private/tagging/tagmapper.php +++ b/lib/private/tagging/tagmapper.php @@ -27,7 +27,7 @@ use \OCP\AppFramework\Db\Mapper, \OCP\IDb; /** - * Thin wrapper around \OCP\AppFramework\Db\Mapper. + * Mapper for Tag entity */ class TagMapper extends Mapper { diff --git a/lib/private/tags.php b/lib/private/tags.php index 1065ba2ef9..bab3d49528 100644 --- a/lib/private/tags.php +++ b/lib/private/tags.php @@ -324,7 +324,7 @@ class Tags implements \OCP\ITags { /** * Rename tag. * - * @param string $from The name of the existing tag + * @param string|integer $from The name or ID of the existing tag * @param string $to The new name of the tag. * @return bool */ @@ -639,7 +639,7 @@ class Tags implements \OCP\ITags { /** * Delete tags from the database. * - * @param string[] $names An array of tags (names or IDs) to delete + * @param string[]|integer[] $names An array of tags (names or IDs) to delete * @return bool Returns false on error */ public function delete($names) { diff --git a/lib/public/itags.php b/lib/public/itags.php index 2b09dcb568..4514746bbe 100644 --- a/lib/public/itags.php +++ b/lib/public/itags.php @@ -114,7 +114,7 @@ interface ITags { /** * Rename tag. * - * @param string $from The name of the existing tag + * @param string|integer $from The name or ID of the existing tag * @param string $to The new name of the tag. * @return bool */ @@ -183,7 +183,7 @@ interface ITags { /** * Delete tags from the database * - * @param string[] $names An array of tags to delete + * @param string[]|integer[] $names An array of tags (names or IDs) to delete * @return bool Returns false on error */ public function delete($names);