Document for phpdoc

Author: danmichaelo

README.md

@@ -41,4 +41,10 @@ $client = new SruClient($url, array(
 
 $response = $client->search('dc.title="Hello world"');
 
+### To generate documentation
+
+    wget http://phpdoc.org/phpDocumentor.phar
+    mkdir docs
+    php phpDocumentor.phar
+
 ```

phpdoc.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdoc>
+  <title>SRU client</title>
+  <parser>
+    <target>docs</target>
+  </parser>
+  <transformer>
+    <target>docs</target>
+  </transformer>
+  <files>
+    <directory>src</directory>
+  </files>
+</phpdoc>

src/Client.php

@@ -1,35 +1,46 @@
 <?php namespace Scriptotek\Sru;
 
-use Danmichaelo\QuiteSimpleXMLElement\QuiteSimpleXMLElement;
 use \Guzzle\Http\Client as HttpClient;
 
+/**
+ * SRU client
+ */
 class Client {
 
+    /** @var HttpClient */
     protected $httpClient;
+
+    /** @var string SRU service base URL */
     protected $url;
+
+    /** @var string Requested schema for the returned records */
     protected $schema;
-    protected $namespaces;
+
+    /** @var string SRU protocol version */
     protected $version;
+
+    /** @var string Some user agent string to identify our client */
     protected $userAgent;
 
     /**
-     * Proxy: Either a string or an array:
-     * - '127.0.0.1:3128' 
-     * - array( '127.0.0.1:3128', 'my_username', 'my_password' )
+     * @var string|string[] Proxy configuration details.
+     *
+     * Either a string 'host:port' or an 
+     * array('host:port', 'username', 'password').
      */
     protected $proxy;
 
     /**
-     * array(username, password)
+     * @var string[] Array containing username and password
      */
     protected $credentials;
 
 	/**
 	 * Create a new client
 	 *
-	 * @param string $url
+	 * @param string $url Base URL to the SRU service
 	 * @param array $options Associative array of options
-	 * @param Guzzle\Http\Client $httpClient
+	 * @param HttpClient $httpClient
 	 */
     public function __construct($url, $options = null, $httpClient = null)
     {
@@ -69,9 +80,9 @@ public function __construct($url, $options = null, $httpClient = null)
     /**
      * Construct the URL for a CQL query
      *
-     * @param string $cql
+     * @param string $cql The CQL query
      * @param int $start Start value in result set (optional)
-     * @param count $count Number of records to request (optional)
+     * @param int $count Number of records to request (optional)
      * @return string
      */
     public function urlTo($cql, $start = 1, $count = 10)
@@ -98,8 +109,8 @@ public function urlTo($cql, $start = 1, $count = 10)
      * 
      * @param string $cql
      * @param int $start Start value in result set (optional)
-     * @param count $count Number of records to request (optional)
-     * @return QuiteSimpleXMLElement
+     * @param int $count Number of records to request (optional)
+     * @return Response
      */
     public function search($cql, $start = 1, $count = 10) {
 

src/Response.php

@@ -2,11 +2,18 @@
 
 use Danmichaelo\QuiteSimpleXMLElement\QuiteSimpleXMLElement;
 
+/**
+ * SRU response, containing a list of records or some error
+ */
 class Response {
 
+    /** @var Record[] */
     public $records;
+
+    /** @var string */
     public $error;
 
+    /** @var string */
     protected $rawResponse;
 
     /**
@@ -33,10 +40,13 @@ public function __construct($text)
             $this->records[] = $record;
         }
 
-        //doc->xpath('/srw:searchRetrieveResponse/
-
     }
 
+    /**
+     * Return the raw xml response
+     *
+     * @return string
+     */
     public function asXml()
     {
         return $this->rawResponse;