Merge pull request #30367 from nextcloud/fix/minor-api-doc-fix

Fix some issues with the API documentation
pull/31269/head
Julius Härtl 2022-02-18 10:44:50 +07:00 committed by GitHub
commit ee711ed66c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 10 deletions

@ -50,20 +50,16 @@ class Section implements IIconSection {
}
/**
* returns the ID of the section. It is supposed to be a lower case string,
* @return string The ID of the section. It is supposed to be a lower case string,
* e.g. 'ldap'
*
* @returns string
*/
public function getID() {
return $this->id;
}
/**
* returns the translated name as it should be displayed, e.g. 'LDAP / AD
* @return string The translated name as it should be displayed, e.g. 'LDAP / AD
* integration'. Use the L10N service to translate it.
*
* @return string
*/
public function getName() {
return $this->name;
@ -81,10 +77,9 @@ class Section implements IIconSection {
}
/**
* returns the relative path to an 16*16 icon describing the section.
* @return string The relative path to an 16*16 icon describing the section.
* e.g. '/core/img/places/files.svg'
*
* @returns string
* @since 12
*/
public function getIcon() {

@ -28,6 +28,8 @@
*/
namespace OCP\Files;
use OCP\Files\Storage\IStorage;
/**
* Interface FileInfo
*
@ -138,7 +140,7 @@ interface FileInfo {
/**
* Get the storage the file or folder is storage on
*
* @return \OCP\Files\Storage
* @return IStorage
* @since 7.0.0
*/
public function getStorage();

@ -31,6 +31,7 @@
namespace OCP\Files;
use OCP\Lock\LockedException;
use OCP\Files\Storage\IStorage;
/**
* Interface Node
@ -87,7 +88,7 @@ interface Node extends FileInfo {
/**
* Get the storage backend the file or folder is stored on
*
* @return Storage
* @return IStorage
* @throws NotFoundException
* @since 6.0.0
*/