From d2a48d58ce2ffa2a599721b8acd78cf25909d236 Mon Sep 17 00:00:00 2001
From: Morris Jobke <morris.jobke@gmail.com>
Date: Sun, 3 Nov 2013 13:38:25 +0100
Subject: [PATCH] fix "No page-level DocBlock"
---
lib/public/api.php | 8 ++++++++
lib/public/app.php | 2 +-
lib/public/defaults.php | 9 ++++++++-
lib/public/groupinterface.php | 2 ++
lib/public/icache.php | 9 +++++++++
lib/public/iconfig.php | 10 +++++++++-
lib/public/icontainer.php | 8 ++++++++
lib/public/idbconnection.php | 8 ++++++++
lib/public/ihelper.php | 8 ++++++++
lib/public/il10n.php | 8 ++++++++
lib/public/image.php | 8 ++++++++
lib/public/inavigationmanager.php | 10 +++++++++-
lib/public/ipreview.php | 9 +++++++++
lib/public/irequest.php | 8 ++++++++
lib/public/iservercontainer.php | 8 ++++++++
lib/public/isession.php | 8 ++++++++
lib/public/itagmanager.php | 13 ++++++++++---
lib/public/itags.php | 8 ++++++++
lib/public/iurlgenerator.php | 8 ++++++++
lib/public/iusersession.php | 8 ++++++++
lib/public/share.php | 9 +++++++++
lib/public/user.php | 2 +-
lib/public/userinterface.php | 4 +++-
23 files changed, 166 insertions(+), 9 deletions(-)
diff --git a/lib/public/api.php b/lib/public/api.php
index d94b68e908a..afee2988635 100644
--- a/lib/public/api.php
+++ b/lib/public/api.php
@@ -20,6 +20,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * API 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;
/**
diff --git a/lib/public/app.php b/lib/public/app.php
index 18681670ddd..9680f0df72c 100644
--- a/lib/public/app.php
+++ b/lib/public/app.php
@@ -22,7 +22,7 @@
/**
* Public interface of ownCloud for apps to use.
- * App Class.
+ * App Class
*
*/
diff --git a/lib/public/defaults.php b/lib/public/defaults.php
index 147f23e341f..5f908e4c5e7 100644
--- a/lib/public/defaults.php
+++ b/lib/public/defaults.php
@@ -20,12 +20,19 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Defaults 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;
/*
* public api to access default strings and urls for your templates
*/
-
class Defaults {
private $defaults;
diff --git a/lib/public/groupinterface.php b/lib/public/groupinterface.php
index 5603faa8265..0a5467f71d6 100644
--- a/lib/public/groupinterface.php
+++ b/lib/public/groupinterface.php
@@ -26,6 +26,8 @@
*
*/
+// 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;
interface GroupInterface extends \OC_Group_Interface {}
diff --git a/lib/public/icache.php b/lib/public/icache.php
index a73004ec9a7..7f594d7a77a 100644
--- a/lib/public/icache.php
+++ b/lib/public/icache.php
@@ -5,6 +5,15 @@
* later.
* See the COPYING-README file.
*/
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * Cache 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;
/**
diff --git a/lib/public/iconfig.php b/lib/public/iconfig.php
index 850bddf6935..d8ac3ae6fc3 100644
--- a/lib/public/iconfig.php
+++ b/lib/public/iconfig.php
@@ -4,9 +4,17 @@
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
- *
+ *
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Config 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;
/**
diff --git a/lib/public/icontainer.php b/lib/public/icontainer.php
index d43c1c90f11..6b7052cc4f4 100644
--- a/lib/public/icontainer.php
+++ b/lib/public/icontainer.php
@@ -20,6 +20,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Container 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;
/**
diff --git a/lib/public/idbconnection.php b/lib/public/idbconnection.php
index 252902eda6c..283e6b56271 100644
--- a/lib/public/idbconnection.php
+++ b/lib/public/idbconnection.php
@@ -7,6 +7,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * DBConnection 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;
/**
diff --git a/lib/public/ihelper.php b/lib/public/ihelper.php
index fad02f7556a..bf07f469f2a 100644
--- a/lib/public/ihelper.php
+++ b/lib/public/ihelper.php
@@ -7,6 +7,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Helper 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;
/**
diff --git a/lib/public/il10n.php b/lib/public/il10n.php
index 805c8988aa2..817b299b0b7 100644
--- a/lib/public/il10n.php
+++ b/lib/public/il10n.php
@@ -7,6 +7,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * L10n 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;
/**
diff --git a/lib/public/image.php b/lib/public/image.php
index c6dd9a113ab..179c086627c 100644
--- a/lib/public/image.php
+++ b/lib/public/image.php
@@ -20,6 +20,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Image 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;
/**
diff --git a/lib/public/inavigationmanager.php b/lib/public/inavigationmanager.php
index f89e790c1d0..a0be14edc31 100644
--- a/lib/public/inavigationmanager.php
+++ b/lib/public/inavigationmanager.php
@@ -4,9 +4,17 @@
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
- *
+ *
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Navigation manager 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;
/**
diff --git a/lib/public/ipreview.php b/lib/public/ipreview.php
index beebd7bd2fa..4d0405c6990 100644
--- a/lib/public/ipreview.php
+++ b/lib/public/ipreview.php
@@ -6,6 +6,15 @@
* later.
* See the COPYING-README file.
*/
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * Preview 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;
/**
diff --git a/lib/public/irequest.php b/lib/public/irequest.php
index 45b27868d70..ca23e12b7f5 100644
--- a/lib/public/irequest.php
+++ b/lib/public/irequest.php
@@ -20,6 +20,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Request 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;
/**
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index cc9436a75c8..14822817a47 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -20,6 +20,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Server container 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;
diff --git a/lib/public/isession.php b/lib/public/isession.php
index 0a77b0c823b..9daab2fe576 100644
--- a/lib/public/isession.php
+++ b/lib/public/isession.php
@@ -8,6 +8,14 @@
* See the COPYING-README file.
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Session 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;
/**
diff --git a/lib/public/itagmanager.php b/lib/public/itagmanager.php
index 07e1d12fc0f..26623d91a63 100644
--- a/lib/public/itagmanager.php
+++ b/lib/public/itagmanager.php
@@ -20,6 +20,16 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Tag manager 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;
+
/**
* Factory class creating instances of \OCP\ITags
*
@@ -30,9 +40,6 @@
* are entered in. If a user already has a tag 'family' for a type, and
* tries to add a tag named 'Family' it will be silently ignored.
*/
-
-namespace OCP;
-
interface ITagManager {
/**
diff --git a/lib/public/itags.php b/lib/public/itags.php
index 5b1ebd189da..50ea0a59b46 100644
--- a/lib/public/itags.php
+++ b/lib/public/itags.php
@@ -20,6 +20,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * Tags 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;
// FIXME: Where should I put this? Or should it be implemented as a Listener?
diff --git a/lib/public/iurlgenerator.php b/lib/public/iurlgenerator.php
index 4eb4c0f8312..6c20734edf0 100644
--- a/lib/public/iurlgenerator.php
+++ b/lib/public/iurlgenerator.php
@@ -7,6 +7,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * URL generator 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;
/**
diff --git a/lib/public/iusersession.php b/lib/public/iusersession.php
index 33d7aeb194c..3b704f68490 100644
--- a/lib/public/iusersession.php
+++ b/lib/public/iusersession.php
@@ -7,6 +7,14 @@
*
*/
+/**
+ * Public interface of ownCloud for apps to use.
+ * User session 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;
/**
diff --git a/lib/public/share.php b/lib/public/share.php
index 7f4d918757f..01bf61a60a5 100644
--- a/lib/public/share.php
+++ b/lib/public/share.php
@@ -18,6 +18,15 @@
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * Share 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;
/**
diff --git a/lib/public/user.php b/lib/public/user.php
index b4931ecc0fa..beb82fee033 100644
--- a/lib/public/user.php
+++ b/lib/public/user.php
@@ -22,7 +22,7 @@
/**
* Public interface of ownCloud for apps to use.
- * User Class.
+ * User Class
*
*/
diff --git a/lib/public/userinterface.php b/lib/public/userinterface.php
index 53d9faf7a5e..4c3444d4c21 100644
--- a/lib/public/userinterface.php
+++ b/lib/public/userinterface.php
@@ -22,10 +22,12 @@
/**
* Public interface of ownCloud for apps to use.
- * User Class.
+ * User 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;
interface UserInterface extends \OC_User_Interface {}
--
GitLab