Browse Source

Fix some issues with the API documentation

Signed-off-by: Carl Schwan <carl@carlschwan.eu>
tags/v24.0.0beta1
Carl Schwan 2 years ago
parent
commit
8af4054237
3 changed files with 8 additions and 10 deletions
  1. 3
    8
      lib/private/Settings/Section.php
  2. 3
    1
      lib/public/Files/FileInfo.php
  3. 2
    1
      lib/public/Files/Node.php

+ 3
- 8
lib/private/Settings/Section.php View File

} }


/** /**
* 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' * e.g. 'ldap'
*
* @returns string
*/ */
public function getID() { public function getID() {
return $this->id; 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. * integration'. Use the L10N service to translate it.
*
* @return string
*/ */
public function getName() { public function getName() {
return $this->name; return $this->name;
} }


/** /**
* 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' * e.g. '/core/img/places/files.svg'
* *
* @returns string
* @since 12 * @since 12
*/ */
public function getIcon() { public function getIcon() {

+ 3
- 1
lib/public/Files/FileInfo.php View File

*/ */
namespace OCP\Files; namespace OCP\Files;


use OCP\Files\Storage\IStorage;

/** /**
* Interface FileInfo * Interface FileInfo
* *
/** /**
* Get the storage the file or folder is storage on * Get the storage the file or folder is storage on
* *
* @return \OCP\Files\Storage
* @return IStorage
* @since 7.0.0 * @since 7.0.0
*/ */
public function getStorage(); public function getStorage();

+ 2
- 1
lib/public/Files/Node.php View File

namespace OCP\Files; namespace OCP\Files;


use OCP\Lock\LockedException; use OCP\Lock\LockedException;
use OCP\Files\Storage\IStorage;


/** /**
* Interface Node * Interface Node
/** /**
* Get the storage backend the file or folder is stored on * Get the storage backend the file or folder is stored on
* *
* @return Storage
* @return IStorage
* @throws NotFoundException * @throws NotFoundException
* @since 6.0.0 * @since 6.0.0
*/ */

Loading…
Cancel
Save