PHPDoc fixes as suggested by @MorrisJobke.

This commit is contained in:
Bernhard Reiter 2014-10-13 23:12:18 +02:00
parent 1770179648
commit b416f7d8ac
4 changed files with 9 additions and 5 deletions

View File

@ -55,8 +55,11 @@ class Tag extends Entity {
/** /**
* Transform a database columnname to a property * Transform a database columnname to a property
*
* @param string $columnName the name of the column * @param string $columnName the name of the column
* @return string the property name * @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){ public function columnToProperty($columnName){
if ($columnName === 'category') { if ($columnName === 'category') {
@ -70,6 +73,7 @@ class Tag extends Entity {
/** /**
* Transform a property to a database column name * Transform a property to a database column name
*
* @param string $property the name of the property * @param string $property the name of the property
* @return string the column name * @return string the column name
*/ */

View File

@ -27,7 +27,7 @@ use \OCP\AppFramework\Db\Mapper,
\OCP\IDb; \OCP\IDb;
/** /**
* Thin wrapper around \OCP\AppFramework\Db\Mapper. * Mapper for Tag entity
*/ */
class TagMapper extends Mapper { class TagMapper extends Mapper {

View File

@ -324,7 +324,7 @@ class Tags implements \OCP\ITags {
/** /**
* Rename tag. * 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. * @param string $to The new name of the tag.
* @return bool * @return bool
*/ */
@ -639,7 +639,7 @@ class Tags implements \OCP\ITags {
/** /**
* Delete tags from the database. * 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 * @return bool Returns false on error
*/ */
public function delete($names) { public function delete($names) {

View File

@ -114,7 +114,7 @@ interface ITags {
/** /**
* Rename tag. * 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. * @param string $to The new name of the tag.
* @return bool * @return bool
*/ */
@ -183,7 +183,7 @@ interface ITags {
/** /**
* Delete tags from the database * 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 * @return bool Returns false on error
*/ */
public function delete($names); public function delete($names);