diff options
author | Morris Jobke <morris.jobke@gmail.com> | 2013-10-17 00:07:29 +0200 |
---|---|---|
committer | Morris Jobke <morris.jobke@gmail.com> | 2013-10-17 00:49:15 +0200 |
commit | 30f4d91d01cc9f0f32767a466a5024ad4f76ebf5 (patch) | |
tree | e11281493b7792b4a770453d85f7ed1c62132ce0 /lib/public/app.php | |
parent | 04783da829d76667079eda56d1f8b66d70813b3d (diff) | |
download | nextcloud-server-30f4d91d01cc9f0f32767a466a5024ad4f76ebf5.tar.gz nextcloud-server-30f4d91d01cc9f0f32767a466a5024ad4f76ebf5.zip |
Public API documentation fixes
refs #4883
* http/response.php
* config.php
* response.php
* files.php
* idbconnection.php
* app.php
* user.php
* template.php
* share.php
* db.php
* icache.php & il10n.php
Diffstat (limited to 'lib/public/app.php')
-rw-r--r-- | lib/public/app.php | 48 |
1 files changed, 23 insertions, 25 deletions
diff --git a/lib/public/app.php b/lib/public/app.php index 0a5721b334e..18681670ddd 100644 --- a/lib/public/app.php +++ b/lib/public/app.php @@ -35,14 +35,12 @@ namespace OCP; */ class App { /** - * @brief Makes ownCloud aware of this app - * @brief This call is deprecated and not necessary to use. - * @param $data array with all information - * @returns boolean + * Makes ownCloud aware of this app + * @param array with all information + * @return boolean * - * @deprecated this method is deprecated - * Do not call it anymore - * It'll remain in our public API for compatibility reasons + * @deprecated This method is deprecated. Do not call it anymore. + * It'll remain in our public API for compatibility reasons. * */ public static function register( $data ) { @@ -50,9 +48,9 @@ class App { } /** - * @brief adds an entry to the navigation - * @param $data array containing the data - * @returns boolean + * Adds an entry to the navigation + * @param array containing the data + * @return boolean * * This function adds a new entry to the navigation visible to users. $data * is an associative array. @@ -71,9 +69,9 @@ class App { } /** - * @brief marks a navigation entry as active - * @param $id string id of the entry - * @returns boolean + * Marks a navigation entry as active + * @param string id of the entry + * @return boolean * * This function sets a navigation entry as active and removes the 'active' * property from all other entries. The templates can use this for @@ -84,7 +82,7 @@ class App { } /** - * @brief Register a Configuration Screen that should appear in the personal settings section. + * Register a Configuration Screen that should appear in the personal settings section. * @param $app string appid * @param $page string page to be included */ @@ -93,7 +91,7 @@ class App { } /** - * @brief Register a Configuration Screen that should appear in the Admin section. + * Register a Configuration Screen that should appear in the Admin section. * @param $app string appid * @param $page string page to be included */ @@ -102,19 +100,19 @@ class App { } /** - * @brief Read app metadata from the info.xml file + * Read app metadata from the info.xml file * @param string $app id of the app or the path of the info.xml file * @param boolean $path (optional) - * @returns array + * @return array */ public static function getAppInfo( $app, $path=false ) { return \OC_App::getAppInfo( $app, $path); } /** - * @brief checks whether or not an app is enabled - * @param $app app - * @returns boolean + * checks whether or not an app is enabled + * @param string + * @return boolean * * This function checks whether or not an app is enabled. */ @@ -123,17 +121,17 @@ class App { } /** - * @brief Check if the app is enabled, redirects to home if not - * @param $app app + * Check if the app is enabled, redirects to home if not + * @param string */ public static function checkAppEnabled( $app ) { \OC_Util::checkAppEnabled( $app ); } /** - * @brief Get the last version of the app, either from appinfo/version or from appinfo/info.xml - * @param $app app - * @returns boolean + * Get the last version of the app, either from appinfo/version or from appinfo/info.xml + * @param string + * @return boolean */ public static function getAppVersion( $app ) { return \OC_App::getAppVersion( $app ); |