page level doc blocks and class descriptions
This commit is contained in:
parent
bc8cc9142e
commit
4e0fa85307
|
@ -20,6 +20,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Activity/IConsumer interface
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Activity;
|
namespace OCP\Activity;
|
||||||
|
|
|
@ -20,6 +20,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Activity/IManager interface
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Activity;
|
namespace OCP\Activity;
|
||||||
|
|
|
@ -20,6 +20,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* AppFramework/App class
|
||||||
|
*/
|
||||||
|
|
||||||
namespace OCP\AppFramework;
|
namespace OCP\AppFramework;
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -20,6 +20,10 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* AppFramework/IApi interface
|
||||||
|
*/
|
||||||
|
|
||||||
namespace OCP\AppFramework;
|
namespace OCP\AppFramework;
|
||||||
|
|
||||||
|
|
|
@ -20,6 +20,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Authentication/IApacheBackend interface
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Authentication;
|
namespace OCP\Authentication;
|
||||||
|
|
|
@ -20,8 +20,16 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/AlreadyExistsException class
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception for already existing files/folders
|
||||||
|
*/
|
||||||
class AlreadyExistsException extends \Exception {}
|
class AlreadyExistsException extends \Exception {}
|
||||||
|
|
|
@ -20,8 +20,16 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/EntityTooLargeException class
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception for too large entity
|
||||||
|
*/
|
||||||
class EntityTooLargeException extends \Exception {}
|
class EntityTooLargeException extends \Exception {}
|
||||||
|
|
|
@ -20,6 +20,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/File interface
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
|
@ -20,8 +20,16 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/InvalidContentException class
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception for invalid content
|
||||||
|
*/
|
||||||
class InvalidContentException extends \Exception {}
|
class InvalidContentException extends \Exception {}
|
||||||
|
|
|
@ -20,8 +20,16 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/InvalidPathException class
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception for invalid path
|
||||||
|
*/
|
||||||
class InvalidPathException extends \Exception {}
|
class InvalidPathException extends \Exception {}
|
||||||
|
|
|
@ -20,8 +20,16 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/NotEnoughSpaceException class
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception for not enough space
|
||||||
|
*/
|
||||||
class NotEnoughSpaceException extends \Exception {}
|
class NotEnoughSpaceException extends \Exception {}
|
||||||
|
|
|
@ -20,8 +20,16 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/NotFoundException class
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception for not found entity
|
||||||
|
*/
|
||||||
class NotFoundException extends \Exception {}
|
class NotFoundException extends \Exception {}
|
||||||
|
|
|
@ -20,8 +20,16 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/NotPermittedException class
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exception for not permitted action
|
||||||
|
*/
|
||||||
class NotPermittedException extends \Exception {}
|
class NotPermittedException extends \Exception {}
|
||||||
|
|
|
@ -20,6 +20,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* Files/Storage interface
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP\Files;
|
namespace OCP\Files;
|
||||||
|
|
|
@ -20,6 +20,11 @@
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public interface of ownCloud for apps to use.
|
||||||
|
* IAddressBook interface
|
||||||
|
*/
|
||||||
|
|
||||||
// use OCP namespace for all classes that are considered public.
|
// use OCP namespace for all classes that are considered public.
|
||||||
// This means that they should be used by apps instead of the internal ownCloud classes
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
||||||
namespace OCP {
|
namespace OCP {
|
||||||
|
|
Loading…
Reference in New Issue