* Document a bit

* Fix some doxygen warnings

diff --git a/includes/ExternalStore.php b/includes/ExternalStore.php
index d759d67..6a77907 100644 (file)
--- 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;

diff --git a/includes/ExternalStoreDB.php b/includes/ExternalStoreDB.php
index 18aa972..769c64d 100644 (file)
--- a/includes/ExternalStoreDB.php
+++ b/includes/ExternalStoreDB.php
@@ -30,28 +30,48 @@ class ExternalStoreDB {
                $this->mParams = $params;
        }
 
-       /** @todo Document.*/
+       /**
+        * Get a LoadBalancer for the specified cluster
+        *
+        * @param $cluster String: cluster name
+        * @return LoadBalancer object
+        */
        function &getLoadBalancer( $cluster ) {
                $wiki = isset($this->mParams['wiki']) ? $this->mParams['wiki'] : false;
                
                return wfGetLBFactory()->getExternalLB( $cluster, $wiki );
        }
 
-       /** @todo Document.*/
+       /**
+        * Get a slave database connection for the specified cluster
+        *
+        * @param $cluster String: cluster name
+        * @return DatabaseBase object
+        */
        function &getSlave( $cluster ) {
                $wiki = isset($this->mParams['wiki']) ? $this->mParams['wiki'] : false;
                $lb =& $this->getLoadBalancer( $cluster );
                return $lb->getConnection( DB_SLAVE, array(), $wiki );
        }
 
-       /** @todo Document.*/
+       /**
+        * Get a master database connection for the specified cluster
+        *
+        * @param $cluster String: cluster name
+        * @return DatabaseBase object
+        */
        function &getMaster( $cluster ) {
                $wiki = isset($this->mParams['wiki']) ? $this->mParams['wiki'] : false;
                $lb =& $this->getLoadBalancer( $cluster );
                return $lb->getConnection( DB_MASTER, array(), $wiki );
        }
 
-       /** @todo Document.*/
+       /**
+        * Get the 'blobs' table name for this database
+        *
+        * @param $db DatabaseBase
+        * @return String: table name ('blobs' by default)
+        */
        function getTable( &$db ) {
                $table = $db->getLBInfo( 'blobs table' );
                if ( is_null( $table ) ) {
@@ -62,7 +82,7 @@ class ExternalStoreDB {
 
        /**
         * Fetch data from given URL
-        * @param string $url An url of the form DB://cluster/id or DB://cluster/id/itemid for concatened storage.
+        * @param $url String: an url of the form DB://cluster/id or DB://cluster/id/itemid for concatened storage.
         */
        function fetchFromURL( $url ) {
                $path = explode( '/', $url );

diff --git a/includes/ExternalStoreHttp.php b/includes/ExternalStoreHttp.php
index 37fbbe6..092ff7d 100644 (file)
--- a/includes/ExternalStoreHttp.php
+++ b/includes/ExternalStoreHttp.php
@@ -1,11 +1,19 @@
 <?php
+
 /**
- * Example class for HTTP accessable external objects
+ * Example class for HTTP accessable external objects.
+ * Only supports reading, not storing.
  *
  * @ingroup ExternalStorage
  */
 class ExternalStoreHttp {
-       /* Fetch data from given URL */
+
+       /**
+        * Fetch data from given URL
+        *
+        * @param $url String: the URL
+        * @return String: the content at $url
+        */
        function fetchFromURL( $url ) {
                $ret = Http::get( $url );
                return $ret;