summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorBernhard Reiter <ockham@raz.or.at>2014-10-13 23:12:18 +0200
committerBernhard Reiter <ockham@raz.or.at>2014-10-14 00:06:33 +0200
commitb416f7d8acabebec94e771394b9e3d69c69cadd5 (patch)
treeae42925d38649e6d42af207236514e5f2b250cd4 /lib
parent17701796480ae1fd53222fa4e59d5fa1b79648db (diff)
downloadnextcloud-server-b416f7d8acabebec94e771394b9e3d69c69cadd5.tar.gz
nextcloud-server-b416f7d8acabebec94e771394b9e3d69c69cadd5.zip
PHPDoc fixes as suggested by @MorrisJobke.
Diffstat (limited to 'lib')
-rw-r--r--lib/private/tagging/tag.php4
-rw-r--r--lib/private/tagging/tagmapper.php2
-rw-r--r--lib/private/tags.php4
-rw-r--r--lib/public/itags.php4
4 files changed, 9 insertions, 5 deletions
diff --git a/lib/private/tagging/tag.php b/lib/private/tagging/tag.php
index d0cd6bbb966..3ea9fbac20b 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 b5929e2618c..6c9bec7aa52 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 1065ba2ef98..bab3d495282 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 2b09dcb5685..4514746bbe8 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);