document the public classes a bit more

remotes/origin/stable4
Frank Karlitschek 13 years ago
parent 35bd601215
commit 08f7d4c552
  1. 3
      lib/public/app.php
  2. 3
      lib/public/config.php
  3. 3
      lib/public/db.php
  4. 3
      lib/public/files.php
  5. 3
      lib/public/json.php
  6. 3
      lib/public/response.php
  7. 2
      lib/public/template.php
  8. 3
      lib/public/user.php
  9. 3
      lib/public/util.php

@ -30,6 +30,9 @@
// 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;
/**
* This class provides functions to manage apps in ownCloud
*/
class App { class App {
/** /**

@ -34,6 +34,9 @@
*/ */
namespace OCP; namespace OCP;
/**
* This class provides functions to read and write configuration data. configuration can be on a system, application or user level
*/
class Config { class Config {

@ -30,6 +30,9 @@
// 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;
/**
* This class provides access to the internal database system. Use this class exlusively if you want to access databases
*/
class DB { class DB {

@ -30,6 +30,9 @@
// 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;
/**
* This class provides access to the internal filesystem abstraction layer. Use this class exlusively if you want to access files
*/
class Files { class Files {

@ -30,6 +30,9 @@
// 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;
/**
* This class provides convinient functions to generate and send JSON data. Usefull for Ajax calls
*/
class JSON { class JSON {

@ -30,6 +30,9 @@
// 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;
/**
* This class provides convinient functions to send the correct http response headers
*/
class Response { class Response {

@ -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 { class Template extends \OC_Template {

@ -30,6 +30,9 @@
// 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;
/**
* 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 { class User {

@ -30,6 +30,9 @@
// 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;
/**
* This class provides different helper functions to make the life of a developer easier
*/
class Util { class Util {

Loading…
Cancel
Save