Commit ba89738c authored by jhodgdon's avatar jhodgdon

Issue #1852288 by underq, aaronott, YesCT, heyrocker, Gábor Hojtsy: Update...

Issue #1852288 by underq, aaronott, YesCT, heyrocker, Gábor Hojtsy: Update documentation to namespace standards
parent 84fddb71
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
/** /**
* @file * @file
* Definition of Drupal\locale\StringStorageInterface. * Contains \Drupal\locale\StringStorageInterface.
*/ */
namespace Drupal\locale; namespace Drupal\locale;
...@@ -30,15 +30,13 @@ interface StringStorageInterface { ...@@ -30,15 +30,13 @@ interface StringStorageInterface {
* - 'pager limit': Use pager and set this limit value. * - 'pager limit': Use pager and set this limit value.
* *
* @return array * @return array
* Array of Drupal\locale\StringInterface objects matching the conditions. * Array of \Drupal\locale\StringInterface objects matching the conditions.
*/ */
public function getStrings(array $conditions = array(), array $options = array()); public function getStrings(array $conditions = array(), array $options = array());
/** /**
* Loads multiple string translation objects. * Loads multiple string translation objects.
* *
* @see Drupal\locale\StringStorageInterface::getStrings()
*
* @param array $conditions * @param array $conditions
* (optional) Array with conditions that will be used to filter the strings * (optional) Array with conditions that will be used to filter the strings
* returned and may include all of the conditions defined by getStrings(). * returned and may include all of the conditions defined by getStrings().
...@@ -47,15 +45,15 @@ public function getStrings(array $conditions = array(), array $options = array() ...@@ -47,15 +45,15 @@ public function getStrings(array $conditions = array(), array $options = array()
* any of the options defined by getStrings(). * any of the options defined by getStrings().
* *
* @return array * @return array
* Array of Drupal\locale\StringInterface objects matching the conditions. * Array of \Drupal\locale\StringInterface objects matching the conditions.
*/ *
* @see \Drupal\locale\StringStorageInterface::getStrings()
*/
public function getTranslations(array $conditions = array(), array $options = array()); public function getTranslations(array $conditions = array(), array $options = array());
/** /**
* Loads string location information. * Loads string location information.
* *
* @see Drupal\locale\StringStorageInterface::getStrings()
*
* @param array $conditions * @param array $conditions
* (optional) Array with conditions to filter the locations that may be any * (optional) Array with conditions to filter the locations that may be any
* of the follwing elements: * of the follwing elements:
...@@ -64,7 +62,9 @@ public function getTranslations(array $conditions = array(), array $options = ar ...@@ -64,7 +62,9 @@ public function getTranslations(array $conditions = array(), array $options = ar
* - 'name', The location name. * - 'name', The location name.
* *
* @return array * @return array
* Array of location objects matching the conditions. * Array of \Drupal\locale\StringInterface objects matching the conditions.
*
* @see \Drupal\locale\StringStorageInterface::getStrings()
*/ */
public function getLocations(array $conditions = array()); public function getLocations(array $conditions = array());
...@@ -79,7 +79,7 @@ public function getLocations(array $conditions = array()); ...@@ -79,7 +79,7 @@ public function getLocations(array $conditions = array());
* (optional) Array with conditions that will be used to filter the strings * (optional) Array with conditions that will be used to filter the strings
* returned and may include all of the conditions defined by getStrings(). * returned and may include all of the conditions defined by getStrings().
* *
* @return Drupal\locale\SourceString|null * @return \Drupal\locale\SourceString|null
* Minimal TranslationString object if found, NULL otherwise. * Minimal TranslationString object if found, NULL otherwise.
*/ */
public function findString(array $conditions); public function findString(array $conditions);
...@@ -95,7 +95,7 @@ public function findString(array $conditions); ...@@ -95,7 +95,7 @@ public function findString(array $conditions);
* (optional) Array with conditions that will be used to filter the strings * (optional) Array with conditions that will be used to filter the strings
* returned and may include all of the conditions defined by getStrings(). * returned and may include all of the conditions defined by getStrings().
* *
* @return Drupal\locale\TranslationString|null * @return \Drupal\locale\TranslationString|null
* Minimal TranslationString object if found, NULL otherwise. * Minimal TranslationString object if found, NULL otherwise.
*/ */
public function findTranslation(array $conditions); public function findTranslation(array $conditions);
...@@ -103,13 +103,13 @@ public function findTranslation(array $conditions); ...@@ -103,13 +103,13 @@ public function findTranslation(array $conditions);
/** /**
* Save string object to storage. * Save string object to storage.
* *
* @param Drupal\locale\StringInterface $string * @param \Drupal\locale\StringInterface $string
* The string object. * The string object.
* *
* @return Drupal\locale\StringStorageInterface * @return \Drupal\locale\StringStorageInterface
* The called object. * The called object.
* *
* @throws Drupal\locale\StringStorageException * @throws \Drupal\locale\StringStorageException
* In case of failures, an exception is thrown. * In case of failures, an exception is thrown.
*/ */
public function save($string); public function save($string);
...@@ -117,13 +117,13 @@ public function save($string); ...@@ -117,13 +117,13 @@ public function save($string);
/** /**
* Delete string from storage. * Delete string from storage.
* *
* @param Drupal\locale\StringInterface $string * @param \Drupal\locale\StringInterface $string
* The string object. * The string object.
* *
* @return Drupal\locale\StringStorageInterface * @return \Drupal\locale\StringStorageInterface
* The called object. * The called object.
* *
* @throws Drupal\locale\StringStorageException * @throws \Drupal\locale\StringStorageException
* In case of failures, an exception is thrown. * In case of failures, an exception is thrown.
*/ */
public function delete($string); public function delete($string);
...@@ -166,7 +166,7 @@ public function countTranslations(); ...@@ -166,7 +166,7 @@ public function countTranslations();
* @param array $values * @param array $values
* (optional) Array with initial values. Defaults to empty array. * (optional) Array with initial values. Defaults to empty array.
* *
* @return Drupal\locale\SourceString * @return \Drupal\locale\SourceString
* New source string object. * New source string object.
*/ */
public function createString($values = array()); public function createString($values = array());
...@@ -177,7 +177,7 @@ public function createString($values = array()); ...@@ -177,7 +177,7 @@ public function createString($values = array());
* @param array $values * @param array $values
* (optional) Array with initial values. Defaults to empty array. * (optional) Array with initial values. Defaults to empty array.
* *
* @return Drupal\locale\TranslationString * @return \Drupal\locale\TranslationString
* New string translation object. * New string translation object.
*/ */
public function createTranslation($values = array()); public function createTranslation($values = array());
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment