add proper exception documentation for ISimpleFS interface

Signed-off-by: Morris Jobke <hey@morrisjobke.de>
This commit is contained in:
Morris Jobke 2016-10-05 23:46:21 +02:00
parent 7512683ea9
commit 316db0a97b
1 changed files with 6 additions and 0 deletions

View File

@ -23,6 +23,7 @@
namespace OCP\Files\SimpleFS; namespace OCP\Files\SimpleFS;
use OCP\Files\NotFoundException; use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
/** /**
* Interface ISimpleRoot * Interface ISimpleRoot
@ -38,6 +39,7 @@ interface ISimpleRoot {
* @param string $name * @param string $name
* @return ISimpleFolder * @return ISimpleFolder
* @throws NotFoundException * @throws NotFoundException
* @throws \RuntimeException
* @since 9.2.0 * @since 9.2.0
*/ */
public function getFolder($name); public function getFolder($name);
@ -46,6 +48,8 @@ interface ISimpleRoot {
* Get all the Folders * Get all the Folders
* *
* @return ISimpleFolder[] * @return ISimpleFolder[]
* @throws NotFoundException
* @throws \RuntimeException
* @since 9.2.0 * @since 9.2.0
*/ */
public function getDirectoryListing(); public function getDirectoryListing();
@ -55,6 +59,8 @@ interface ISimpleRoot {
* *
* @param string $name * @param string $name
* @return ISimpleFolder * @return ISimpleFolder
* @throws NotPermittedException
* @throws \RuntimeException
* @since 9.2.0 * @since 9.2.0
*/ */
public function newFolder($name); public function newFolder($name);