Cleanup some docs :)
authorChad Horohoe <demon@users.mediawiki.org>
Mon, 29 Sep 2008 06:12:47 +0000 (06:12 +0000)
committerChad Horohoe <demon@users.mediawiki.org>
Mon, 29 Sep 2008 06:12:47 +0000 (06:12 +0000)
includes/HttpFunctions.php

index c0a6226..978509e 100644 (file)
@@ -3,26 +3,38 @@
 /**
  * @defgroup HTTP HTTP
  * @file
+ * @ingroup HTTP
  */
+
 /**
  * Various HTTP related functions
  * @ingroup HTTP
  */
 class Http {
+
+       /**
+        * Simple wrapper for Http::request( 'GET' )
+        * @see Http::request()
+        */
        static function get( $url, $timeout = 'default', $opts = array() ) {
                return Http::request( "GET", $url, $timeout, $opts );
        }
 
+       /**
+        * Simple wrapper for Http::request( 'POST' )
+        * @see Http::request()
+        */
        static function post( $url, $timeout = 'default', $opts = array() ) {
                return Http::request( "POST", $url, $timeout, $opts );
        }
 
        /**
         * Get the contents of a file by HTTP
-        *
-        * if $timeout is 'default', $wgHTTPTimeout is used
+        * @param $method string HTTP method. Usually GET/POST
+        * @param $url string Full URL to act on
+        * @param $timeout int Seconds to timeout. 'default' falls to $wgHTTPTimeout
+        * @param $curlOptions array Optional array of extra params to pass 
+        * to curl_setopt()
         */
        static function request( $method, $url, $timeout = 'default', $curlOptions = array() ) {
                global $wgHTTPTimeout, $wgHTTPProxy, $wgVersion, $wgTitle;
@@ -104,6 +116,8 @@ class Http {
 
        /**
         * Check if the URL can be served by localhost
+        * @param $url string Full url to check
+        * @return bool
         */
        static function isLocalURL( $url ) {
                global $wgCommandLineMode, $wgConf;