Fix doc blocks

Signed-off-by: Joas Schilling <[email protected]>

core/Controller/CollaborationResourcesController.php

@@ -87,7 +87,7 @@ public function listCollection(int $collectionId): DataResponse {
 	/**
 	 * @NoAdminRequired
 	 *
-	 * @param int $collectionId
+	 * @param string $filter
 	 * @return DataResponse
 	 */
 	public function searchCollections(string $filter): DataResponse {
@@ -179,8 +179,8 @@ public function getCollectionsByResource(string $resourceType, string $resourceI
 	/**
 	 * @NoAdminRequired
 	 *
-	 * @param string $resourceType
-	 * @param string $resourceId
+	 * @param string $baseResourceType
+	 * @param string $baseResourceId
 	 * @param string $name
 	 * @return DataResponse
 	 */

lib/private/Collaboration/Resources/Collection.php

@@ -64,23 +64,23 @@ public function __construct(
 
 	/**
 	 * @return int
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getId(): int {
 		return $this->id;
 	}
 
 	/**
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getName(): string {
 		return $this->name;
 	}
 
 	/**
 	 * @return IResource[]
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getResources(): array {
 		if (empty($this->resources)) {
@@ -104,7 +104,7 @@ public function getResources(): array {
 	 *
 	 * @param IResource $resource
 	 * @throws ResourceException when the resource is already part of the collection
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function addResource(IResource $resource) {
 		array_map(function(IResource $r) use ($resource) {
@@ -134,7 +134,7 @@ public function addResource(IResource $resource) {
 	 * Removes a resource from a collection
 	 *
 	 * @param IResource $resource
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function removeResource(IResource $resource) {
 		$this->resources = array_filter($this->resources, function(IResource $r) use ($resource) {
@@ -158,7 +158,7 @@ public function removeResource(IResource $resource) {
 	 *
 	 * @param IUser $user
 	 * @return bool
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function canAccess(IUser $user = null): bool {
 		foreach ($this->getResources() as $resource) {

lib/private/Collaboration/Resources/Manager.php

@@ -49,7 +49,7 @@ public function __construct(IDBConnection $connection) {
 	 * @param int $id
 	 * @return ICollection
 	 * @throws CollectionException when the collection could not be found
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getCollection(int $id): ICollection {
 		$query = $this->connection->getQueryBuilder();
@@ -68,10 +68,12 @@ public function getCollection(int $id): ICollection {
 	}
 
 	/**
-	 * @param int $id
-	 * @return ICollection
-	 * @throws CollectionException when the collection could not be found
-	 * @since 15.0.0
+	 * @param IUser $user
+	 * @param string $filter
+	 * @param int $limit
+	 * @param int $start
+	 * @return ICollection[]
+	 * @since 16.0.0
 	 */
 	public function searchCollections(IUser $user, string $filter, int $limit = 50, int $start = 0): array {
 		$query = $this->connection->getQueryBuilder();
@@ -99,7 +101,7 @@ public function searchCollections(IUser $user, string $filter, int $limit = 50,
 	/**
 	 * @param string $name
 	 * @return ICollection
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function newCollection(string $name): ICollection {
 		$query = $this->connection->getQueryBuilder();
@@ -116,15 +118,15 @@ public function newCollection(string $name): ICollection {
 	 * @param string $type
 	 * @param string $id
 	 * @return IResource
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getResource(string $type, string $id): IResource {
 		return new Resource($this, $this->connection, $type, $id);
 	}
 
 	/**
 	 * @return IProvider[]
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getProviders(): array {
 		return $this->providers;
@@ -135,7 +137,7 @@ public function getProviders(): array {
 	 *
 	 * @param IResource $resource
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getName(IResource $resource): string {
 		foreach ($this->getProviders() as $provider) {
@@ -174,7 +176,7 @@ public function getIconClass(IResource $resource): string {
 	 * @param IResource $resource
 	 * @param IUser $user
 	 * @return bool
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function canAccess(IResource $resource, IUser $user = null): bool {
 		foreach ($this->getProviders() as $provider) {
@@ -203,7 +205,7 @@ public function registerResourceProvider(IProvider $provider): void {
 	 *
 	 * @param IResource $resource
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getType(): string {
 		return '';
@@ -214,7 +216,7 @@ public function getType(): string {
 	 *
 	 * @param IResource $resource
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getLink(IResource $resource): string {
 		foreach ($this->getProviders() as $provider) {
@@ -232,7 +234,7 @@ public function getLink(IResource $resource): string {
 	/**
 	 * @param string $name
 	 * @return ICollection
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function renameCollection(int $id, string $name): ICollection {
 		$query = $this->connection->getQueryBuilder();

lib/private/Collaboration/Resources/Resource.php

@@ -67,23 +67,23 @@ public function __construct(
 
 	/**
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getType(): string {
 		return $this->type;
 	}
 
 	/**
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getId(): string {
 		return $this->id;
 	}
 
 	/**
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getName(): string {
 		if ($this->name === null) {
@@ -95,7 +95,7 @@ public function getName(): string {
 
 	/**
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getIconClass(): string {
 		if ($this->iconClass === null) {
@@ -119,15 +119,15 @@ public function getLink(): string {
 	 *
 	 * @param IUser $user
 	 * @return bool
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function canAccess(IUser $user = null): bool {
 		return $this->manager->canAccess($this, $user);
 	}
 
 	/**
 	 * @return ICollection[]
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getCollections(): array {
 		$collections = [];

lib/public/Collaboration/Resources/CollectionException.php

@@ -22,7 +22,9 @@
 
 namespace OCP\Collaboration\Resources;
 
-
+/**
+ * @since 16.0.0
+ */
 class CollectionException extends \RuntimeException {
 
 }

lib/public/Collaboration/Resources/ICollection.php

@@ -25,25 +25,25 @@
 use OCP\IUser;
 
 /**
- * @since 15.0.0
+ * @since 16.0.0
  */
 interface ICollection {
 
 	/**
 	 * @return int
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getId(): int;
 
 	/**
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getName(): string;
 
 	/**
 	 * @return IResource[]
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getResources(): array;
 
@@ -52,15 +52,15 @@ public function getResources(): array;
 	 *
 	 * @param IResource $resource
 	 * @throws ResourceException when the resource is already part of the collection
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function addResource(IResource $resource);
 
 	/**
 	 * Removes a resource from a collection
 	 *
 	 * @param IResource $resource
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function removeResource(IResource $resource);
 
@@ -69,7 +69,7 @@ public function removeResource(IResource $resource);
 	 *
 	 * @param IUser $user
 	 * @return bool
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function canAccess(IUser $user = null): bool;
 }

lib/public/Collaboration/Resources/IManager.php

@@ -23,38 +23,38 @@
 namespace OCP\Collaboration\Resources;
 
 /**
- * @since 15.0.0
+ * @since 16.0.0
  */
 interface IManager extends IProvider {
 
 	/**
 	 * @param int $id
 	 * @return ICollection
 	 * @throws CollectionException when the collection could not be found
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getCollection(int $id): ICollection;
 
 	/**
 	 * @param string $name
 	 * @return ICollection
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function newCollection(string $name): ICollection;
 
 
 	/**
 	 * @param string $name
 	 * @return ICollection
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function renameCollection(int $id, string $name): ICollection;
 
 	/**
 	 * @param string $type
 	 * @param string $id
 	 * @return IResource
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getResource(string $type, string $id): IResource;
 

lib/public/Collaboration/Resources/IProvider.php

@@ -24,14 +24,17 @@
 
 use OCP\IUser;
 
+/**
+ * @since 16.0.0
+ */
 interface IProvider {
 
 	/**
 	 * Get the type of a resource
 	 *
 	 * @param IResource $resource
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getType(): string;
 
@@ -40,7 +43,7 @@ public function getType(): string;
 	 *
 	 * @param IResource $resource
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getName(IResource $resource): string;
 
@@ -49,7 +52,7 @@ public function getName(IResource $resource): string;
 	 *
 	 * @param IResource $resource
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getIconClass(IResource $resource): string;
 
@@ -58,7 +61,7 @@ public function getIconClass(IResource $resource): string;
 	 *
 	 * @param IResource $resource
 	 * @return string
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function getLink(IResource $resource): string;
 
@@ -68,7 +71,7 @@ public function getLink(IResource $resource): string;
 	 * @param IResource $resource
 	 * @param IUser $user
 	 * @return bool
-	 * @since 15.0.0
+	 * @since 16.0.0
 	 */
 	public function canAccess(IResource $resource, IUser $user = null): bool;