From 9d4cfc9508b03a579dd62a28c0e9e428b5052f9b Mon Sep 17 00:00:00 2001 From: gggeek Date: Sun, 24 Jan 2016 21:18:22 +0000 Subject: [PATCH] Fix pakefile to build from master branch; add a description for every class for better phpdoc output --- pakefile.php | 2 +- src/Client.php | 2 +- src/Encoder.php | 3 +++ src/PhpXmlRpc.php | 3 +++ src/Request.php | 2 +- src/Response.php | 2 +- src/Server.php | 5 ++++- src/Value.php | 2 +- src/Wrapper.php | 3 +-- 9 files changed, 16 insertions(+), 8 deletions(-) diff --git a/pakefile.php b/pakefile.php index 74bcba8..fc2633b 100644 --- a/pakefile.php +++ b/pakefile.php @@ -22,7 +22,7 @@ class Builder ); protected static $options = array( 'repo' => 'https://github.com/gggeek/phpxmlrpc', - 'branch' => 'php53' + 'branch' => 'master' ); public static function libVersion() diff --git a/src/Client.php b/src/Client.php index c884a25..af17679 100644 --- a/src/Client.php +++ b/src/Client.php @@ -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 { diff --git a/src/Encoder.php b/src/Encoder.php index b9bdb08..220ce88 100644 --- a/src/Encoder.php +++ b/src/Encoder.php @@ -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 { /** diff --git a/src/PhpXmlRpc.php b/src/PhpXmlRpc.php index 086a90a..9a72ebd 100644 --- a/src/PhpXmlRpc.php +++ b/src/PhpXmlRpc.php @@ -2,6 +2,9 @@ namespace PhpXmlRpc; +/** + * Manages global configuration for operation of the library. + */ class PhpXmlRpc { static public $xmlrpcerr = array( diff --git a/src/Request.php b/src/Request.php index 42ed075..0051e46 100644 --- a/src/Request.php +++ b/src/Request.php @@ -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 diff --git a/src/Response.php b/src/Response.php index 16ff0a8..48ebca8 100644 --- a/src/Response.php +++ b/src/Response.php @@ -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. */ diff --git a/src/Server.php b/src/Server.php index b098d68..382630e 100644 --- a/src/Server.php +++ b/src/Server.php @@ -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 */ diff --git a/src/Value.php b/src/Value.php index c9fc614..385d92b 100644 --- a/src/Value.php +++ b/src/Value.php @@ -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 { diff --git a/src/Wrapper.php b/src/Wrapper.php index 7a8af5e..8ea8f2d 100644 --- a/src/Wrapper.php +++ b/src/Wrapper.php @@ -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? -- 2.43.0