document the public classes a bit more

diff --git a/lib/public/app.php b/lib/public/app.php
index 618ea03ad0f8a3bbefd8323020c3a3401017df19..fc277b6ae9ac3ceaa661bff55c5604284bc7edab 100644 (file)
--- a/lib/public/app.php
+++ b/lib/public/app.php
@@ -30,6 +30,9 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP;
 
+/**
+ * This class provides functions to manage apps in ownCloud
+ */
 class App {
 
         /**

diff --git a/lib/public/config.php b/lib/public/config.php
index eb42277292d7b37b10e717915f4413f24431f906..762fb6b18008ba177ed98f8c5541b6706fa8b52f 100644 (file)
--- a/lib/public/config.php
+++ b/lib/public/config.php
@@ -34,6 +34,9 @@
  */
 namespace OCP;
 
+/**
+ * This class provides functions to read and write configuration data. configuration can be on a system, application or user level
+ */
 class Config {
 
 

diff --git a/lib/public/db.php b/lib/public/db.php
index 7ba98e2851e3ebc57948a07151093c4e7ec2113f..af2e46c9da29aefd16f5582da3f1e76dec92b6e0 100644 (file)
--- a/lib/public/db.php
+++ b/lib/public/db.php
@@ -30,6 +30,9 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP;
 
+/**
+ * This class provides access to the internal database system. Use this class exlusively if you want to access databases
+ */
 class DB {
 
 

diff --git a/lib/public/files.php b/lib/public/files.php
index e11ab81e16fb1c00a84982053ffede0ed98e87b5..4e9e9e79804fa7e4c44a13bd035ce0ef40125c62 100644 (file)
--- a/lib/public/files.php
+++ b/lib/public/files.php
@@ -30,6 +30,9 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP;
 
+/**
+ * This class provides access to the internal filesystem abstraction layer. Use this class exlusively if you want to access files
+ */
 class Files {
 
 

diff --git a/lib/public/json.php b/lib/public/json.php
index 7fc6a0b01d4a2df6f3471768d7346bcb608a690e..439721ac6cec3151dc2a52645bda6e4d9a6b996f 100644 (file)
--- a/lib/public/json.php
+++ b/lib/public/json.php
@@ -30,6 +30,9 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP;
 
+/**
+ * This class provides convinient functions to generate and send JSON data. Usefull for Ajax calls
+ */
 class JSON {
 
 

diff --git a/lib/public/response.php b/lib/public/response.php
index 5049b0c54cf2f9da511be60899b9659fecbe8a21..c35c2654965b5ce52498bd2fd15a60a95e70df2c 100644 (file)
--- a/lib/public/response.php
+++ b/lib/public/response.php
@@ -30,6 +30,9 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP;
 
+/**
+ * This class provides convinient functions to send the correct http response headers
+ */
 class Response {
 
 

diff --git a/lib/public/template.php b/lib/public/template.php
index 3d1ab2c7c2e4222fdb6bb4582457cc54bf6ff2b0..33eefea3b8002b0e5b8183eedba14c3a17c78178 100644 (file)
--- a/lib/public/template.php
+++ b/lib/public/template.php
@@ -99,7 +99,7 @@ function html_select_options($options, $selected, $params=array()) {
 
 
 /**
- * This class provides the templates for owncloud.
+ * This class provides the template system for owncloud. You can use it to load specific templates, add data and generate the html code
  */
 class Template extends \OC_Template {
 

diff --git a/lib/public/user.php b/lib/public/user.php
index 53ff8d25fc57762e2bc465ce02bc148d81a9331f..d351b001e8f65977b9de8d5ecf7a15e945dd5f07 100644 (file)
--- a/lib/public/user.php
+++ b/lib/public/user.php
@@ -30,6 +30,9 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP;
 
+/**
+ * This class provides access to the user management. You can get information about the currently logged in user and the permissions for example
+ */
 class User {
 
 

diff --git a/lib/public/util.php b/lib/public/util.php
index 749531feafdabc6760f80c628fc419017fa3e427..3d20c5a46353961b78f24db2aeec4f62a917c9d9 100644 (file)
--- a/lib/public/util.php
+++ b/lib/public/util.php
@@ -30,6 +30,9 @@
 // This means that they should be used by apps instead of the internal ownCloud classes
 namespace OCP;
 
+/**
+ * This class provides different helper functions to make the life of a developer easier
+ */
 class Util {