X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;f=includes%2FExternalStore.php;h=6a7790793f1f44f0dda5af555843c561142f00e7;hb=7fa78fefa902e7e8f30267d98fcd99d25b473542;hp=d759d67097c291b37fa217f099d25b5c8bf35439;hpb=76635cbaf012d028c6f3f78fe2de8bfa5f2276ff;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/ExternalStore.php b/includes/ExternalStore.php
index d759d67097..6a7790793f 100644
--- a/includes/ExternalStore.php
+++ b/includes/ExternalStore.php
@@ -19,7 +19,13 @@ class ExternalStore {
 		$this->mParams = $params;
 	}
 	
-	/* Fetch data from given URL */
+	/**
+	 * Fetch data from given URL
+	 *
+	 * @param $url String: The URL of the text to get
+	 * @param $params Array: associative array of parameters for the ExternalStore object.
+	 * @return The text stored or false on error
+	 */
 	static function fetchFromURL( $url, $params = array() ) {
 		global $wgExternalStores;
 
@@ -39,6 +45,10 @@ class ExternalStore {
 
 	/**
 	 * Get an external store object of the given type, with the given parameters
+	 *
+	 * @param $proto String: type of external storage, should be a value in $wgExternalStores
+	 * @param $params Array: associative array of parameters for the ExternalStore object.
+	 * @return ExternalStore subclass or false on error
 	 */
 	static function getStoreObject( $proto, $params = array() ) {
 		global $wgExternalStores;
@@ -61,7 +71,7 @@ class ExternalStore {
 	 * Store a data item to an external store, identified by a partial URL
 	 * The protocol part is used to identify the class, the rest is passed to the
 	 * class itself as a parameter.
-	 * Returns the URL of the stored data item, or false on error
+	 * @return The URL of the stored data item, or false on error
 	 */
 	static function insert( $url, $data, $params = array() ) {
 		list( $proto, $params ) = explode( '://', $url, 2 );
@@ -78,9 +88,9 @@ class ExternalStore {
 	 * This function does not need a url param, it builds it by
 	 * itself. It also fails-over to the next possible clusters.
 	 *
-	 * @param string $data
-	 * @param array $params Associative array of parameters for the ExternalStore object.
-	 * Returns the URL of the stored data item, or false on error
+	 * @param $data String
+	 * @param $storageParams Array: associative array of parameters for the ExternalStore object.
+	 * @return The URL of the stored data item, or false on error
 	 */
 	public static function insertToDefault( $data, $storageParams = array() ) {
 		global $wgDefaultExternalStore;