diff options
| -rw-r--r-- | lib/public/app.php | 3 | ||||
| -rw-r--r-- | lib/public/config.php | 3 | ||||
| -rw-r--r-- | lib/public/db.php | 3 | ||||
| -rw-r--r-- | lib/public/files.php | 3 | ||||
| -rw-r--r-- | lib/public/json.php | 3 | ||||
| -rw-r--r-- | lib/public/response.php | 3 | ||||
| -rw-r--r-- | lib/public/template.php | 2 | ||||
| -rw-r--r-- | lib/public/user.php | 3 | ||||
| -rw-r--r-- | lib/public/util.php | 3 |
9 files changed, 25 insertions, 1 deletions
diff --git a/lib/public/app.php b/lib/public/app.php index 618ea03ad0f..fc277b6ae9a 100644 --- 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 eb42277292d..762fb6b1800 100644 --- 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 7ba98e2851e..af2e46c9da2 100644 --- 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 e11ab81e16f..4e9e9e79804 100644 --- 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 7fc6a0b01d4..439721ac6ce 100644 --- 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 5049b0c54cf..c35c2654965 100644 --- 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 3d1ab2c7c2e..33eefea3b80 100644 --- 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 53ff8d25fc5..d351b001e8f 100644 --- 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 749531feafd..3d20c5a4635 100644 --- 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 { |