Fix pakefile to build from master branch; add a description for every class for bette...
authorgggeek <giunta.gaetano@gmail.com>
Sun, 24 Jan 2016 21:18:22 +0000 (21:18 +0000)
committergggeek <giunta.gaetano@gmail.com>
Sun, 24 Jan 2016 21:18:22 +0000 (21:18 +0000)
pakefile.php
src/Client.php
src/Encoder.php
src/PhpXmlRpc.php
src/Request.php
src/Response.php
src/Server.php
src/Value.php
src/Wrapper.php

index 74bcba8..fc2633b 100644 (file)
@@ -22,7 +22,7 @@ class Builder
     );
     protected static $options = array(
         'repo' => 'https://github.com/gggeek/phpxmlrpc',
-        'branch' => 'php53'
+        'branch' => 'master'
     );
 
     public static function libVersion()
index c884a25..af17679 100644 (file)
@@ -5,7 +5,7 @@ namespace PhpXmlRpc;
 use PhpXmlRpc\Helper\Logger;
 
 /**
- * The basic class used to represent a client of an XML-RPC server.
+ * Used to represent a client of an XML-RPC server.
  */
 class Client
 {
index b9bdb08..220ce88 100644 (file)
@@ -4,6 +4,9 @@ namespace PhpXmlRpc;
 
 use PhpXmlRpc\Helper\XMLParser;
 
+/**
+ * A helper class to easily convert between Value objects and php native values
+ */
 class Encoder
 {
     /**
index 086a90a..9a72ebd 100644 (file)
@@ -2,6 +2,9 @@
 
 namespace PhpXmlRpc;
 
+/**
+ * Manages global configuration for operation of the library.
+ */
 class PhpXmlRpc
 {
     static public $xmlrpcerr = array(
index 42ed075..0051e46 100644 (file)
@@ -8,7 +8,7 @@ use PhpXmlRpc\Helper\Logger;
 use PhpXmlRpc\Helper\XMLParser;
 
 /**
- * This class provides a representation for a request to an XML-RPC server.
+ * This class provides the representation of a request to an XML-RPC server.
  * A client sends a PhpXmlrpc\Request to a server, and receives back an PhpXmlrpc\Response.
  */
 class Request
index 16ff0a8..48ebca8 100644 (file)
@@ -5,7 +5,7 @@ namespace PhpXmlRpc;
 use PhpXmlRpc\Helper\Charset;
 
 /**
- * This class is used to contain responses to XML-RPC requests.
+ * This class provides the representation of the response of an XML-RPC server.
  * Server-side, a server method handler will construct a Response and pass it as its return value.
  * An identical Response object will be returned by the result of an invocation of the send() method of the Client class.
  */
index b098d68..382630e 100644 (file)
@@ -5,6 +5,9 @@ namespace PhpXmlRpc;
 use PhpXmlRpc\Helper\XMLParser;
 use PhpXmlRpc\Helper\Charset;
 
+/**
+ * Allows effortless implementation of XML-RPC servers
+ */
 class Server
 {
     /**
@@ -720,7 +723,7 @@ class Server
     }
 
     /**
-     * add a string to the 'internal debug message' (separate from 'user debug message').
+     * Add a string to the 'internal debug message' (separate from 'user debug message').
      *
      * @param string $string
      */
index c9fc614..385d92b 100644 (file)
@@ -5,7 +5,7 @@ namespace PhpXmlRpc;
 use PhpXmlRpc\Helper\Charset;
 
 /**
- * This class enables the creation and encapsulation of values for XML-RPC.
+ * This class enables the creation of values for XML-RPC, by encapsulating plain php values.
  */
 class Value implements \Countable, \IteratorAggregate, \ArrayAccess
 {
index 7a8af5e..8ea8f2d 100644 (file)
@@ -8,8 +8,7 @@
 namespace PhpXmlRpc;
 
 /**
- * PHP-XMLRPC "wrapper" class.
- * Generate stubs to transparently access xmlrpc methods as php functions and vice-versa.
+ * PHP-XMLRPC "wrapper" class - generate stubs to transparently access xmlrpc methods as php functions and vice-versa.
  * Note: this class implements the PROXY pattern, but it is not named so to avoid confusion with http proxies.
  *
  * @todo use some better templating system for code generation?