Merge pull request #7486 from owncloud/l10n_docstrings

Fix some docstrings in l10n.php
This commit is contained in:
Morris Jobke 2014-03-01 10:38:48 +01:00
commit 084050530c
1 changed files with 15 additions and 13 deletions

View File

@ -73,8 +73,8 @@ class OC_L10N implements \OCP\IL10N {
/**
* get an L10N instance
* @param $app string
* @param $lang string|null
* @param string $app
* @param string|null $lang
* @return OC_L10N
*/
public static function get($app, $lang=null) {
@ -87,8 +87,8 @@ class OC_L10N implements \OCP\IL10N {
/**
* @brief The constructor
* @param $app string app requesting l10n
* @param $lang string default: null Language
* @param string $app app requesting l10n
* @param string $lang default: null Language
* @returns OC_L10N-Object
*
* If language is not set, the constructor tries to find the right
@ -237,7 +237,7 @@ class OC_L10N implements \OCP\IL10N {
/**
* @brief Translating
* @param $text String The text we need a translation for
* @param string $text The text we need a translation for
* @param array $parameters default:array() Parameters for sprintf
* @return \OC_L10N_String Translation or the same text
*
@ -250,9 +250,9 @@ class OC_L10N implements \OCP\IL10N {
/**
* @brief Translating
* @param $text_singular String the string to translate for exactly one object
* @param $text_plural String the string to translate for n objects
* @param $count Integer Number of objects
* @param string $text_singular the string to translate for exactly one object
* @param string $text_plural the string to translate for n objects
* @param integer $count Number of objects
* @param array $parameters default:array() Parameters for sprintf
* @return \OC_L10N_String Translation or the same text
*
@ -351,7 +351,7 @@ class OC_L10N implements \OCP\IL10N {
/**
* @brief Localization
* @param $type Type of localization
* @param string $type Type of localization
* @param $params parameters for this localization
* @returns String or false
*
@ -406,7 +406,7 @@ class OC_L10N implements \OCP\IL10N {
/**
* @brief Choose a language
* @param $texts Associative Array with possible strings
* @param array $text Associative Array with possible strings
* @returns String
*
* $text is an array 'de' => 'hallo welt', 'en' => 'hello world', ...
@ -421,7 +421,7 @@ class OC_L10N implements \OCP\IL10N {
/**
* @brief find the best language
* @param $app Array or string, details below
* @param array|string $app details below
* @returns string language
*
* If $app is an array, ownCloud assumes that these are the available
@ -494,7 +494,7 @@ class OC_L10N implements \OCP\IL10N {
/**
* @brief find the l10n directory
* @param $app App that needs to be translated
* @param string $app App that needs to be translated
* @returns directory
*/
protected static function findI18nDir($app) {
@ -514,7 +514,7 @@ class OC_L10N implements \OCP\IL10N {
/**
* @brief find all available languages for an app
* @param $app App that needs to be translated
* @param string $app App that needs to be translated
* @returns array an array of available languages
*/
public static function findAvailableLanguages($app=null) {
@ -533,7 +533,9 @@ class OC_L10N implements \OCP\IL10N {
}
/**
* @param string $app
* @param string $lang
* @returns bool
*/
public static function languageExists($app, $lang) {
if ($lang == 'en') {//english is always available