page level doc blocks and class descriptions

lib/public/activity/iconsumer.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Activity;

lib/public/activity/imanager.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Activity;

lib/public/appframework/app.php

@@ -20,6 +20,11 @@
  *
  */
 
+/**
+ * Public interface of ownCloud for apps to use.
+ * AppFramework/App class
+ */
+
 namespace OCP\AppFramework;
 
 

lib/public/appframework/iapi.php

@@ -20,6 +20,10 @@
  *
  */
 
+/**
+ * Public interface of ownCloud for apps to use.
+ * AppFramework/IApi interface
+ */
 
 namespace OCP\AppFramework;
 

lib/public/authentication/iapachebackend.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Authentication;

lib/public/files/alreadyexistsexception.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;
 
+/**
+ * Exception for already existing files/folders
+ */
 class AlreadyExistsException extends \Exception {}

lib/public/files/entitytoolargeexception.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;
 
+/**
+ * Exception for too large entity
+ */
 class EntityTooLargeException extends \Exception {}

lib/public/files/file.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;

lib/public/files/invalidcontentexception.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;
 
+/**
+ * Exception for invalid content
+ */
 class InvalidContentException extends \Exception {}

lib/public/files/invalidpathexception.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;
 
+/**
+ * Exception for invalid path
+ */
 class InvalidPathException extends \Exception {}

lib/public/files/notenoughspaceexception.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;
 
+/**
+ * Exception for not enough space
+ */
 class NotEnoughSpaceException extends \Exception {}

lib/public/files/notfoundexception.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;
 
+/**
+ * Exception for not found entity
+ */
 class NotFoundException extends \Exception {}

lib/public/files/notpermittedexception.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;
 
+/**
+ * Exception for not permitted action
+ */
 class NotPermittedException extends \Exception {}

lib/public/files/storage.php

@@ -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.
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP\Files;

lib/public/iaddressbook.php

@@ -20,6 +20,11 @@
  *
  */
 
+/**
+ * Public interface of ownCloud for apps to use.
+ * IAddressBook interface
+ */
+
 // 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
 namespace OCP {