Documentation update

dcarbone · Apr 6, 2017 · d271725 · d271725
1 parent 75f806d
commit d271725
Show file tree

Hide file tree

Showing 28 changed files with 156 additions and 183 deletions.
diff --git a/src/ACL/ACLClient.php b/src/ACL/ACLClient.php
@@ -28,8 +28,8 @@
 class ACLClient extends AbstractClient
 {
     /**
-     * @param ACLEntry $acl
-     * @param WriteOptions|null $writeOptions
+     * @param \DCarbone\PHPConsulAPI\ACL\ACLEntry $acl
+     * @param \DCarbone\PHPConsulAPI\WriteOptions|null $writeOptions
      * @return array(
      * @type string ACL ID
      * @type \DCarbone\PHPConsulAPI\WriteMeta write meta data
@@ -56,8 +56,8 @@ public function create(ACLEntry $acl, WriteOptions $writeOptions = null)
     }
 
     /**
-     * @param ACLEntry $acl
-     * @param WriteOptions|null $writeOptions
+     * @param \DCarbone\PHPConsulAPI\ACL\ACLEntry $acl
+     * @param \DCarbone\PHPConsulAPI\WriteOptions|null $writeOptions
      * @return array(
      * @type \DCarbone\PHPConsulAPI\WriteMeta
      * @type \DCarbone\PHPConsulAPI\Error|null error, if any
@@ -78,7 +78,7 @@ public function update(ACLEntry $acl, WriteOptions $writeOptions = null)
 
     /**
      * @param string $id
-     * @param WriteOptions|null $writeOptions
+     * @param \DCarbone\PHPConsulAPI\WriteOptions|null $writeOptions
      * @return array(
      * @type \DCarbone\PHPConsulAPI\WriteMeta write meta data
      * @type \DCarbone\PHPConsulAPI\Error|null error, if any
@@ -99,7 +99,7 @@ public function destroy($id, WriteOptions $writeOptions = null)
 
     /**
      * @param string $id
-     * @param WriteOptions|null $writeOptions
+     * @param \DCarbone\PHPConsulAPI\WriteOptions|null $writeOptions
      * @return array(
      * @type string cloned ACL id
      * @type \DCarbone\PHPConsulAPI\WriteMeta write meta data
@@ -127,7 +127,7 @@ public function cloneACL($id, WriteOptions $writeOptions = null)
 
     /**
      * @param string $id
-     * @param QueryOptions|null $queryOptions
+     * @param \DCarbone\PHPConsulAPI\QueryOptions|null $queryOptions
      * @return array(
      * @type \DCarbone\PHPConsulAPI\ACL\ACLEntry[]|null list of ACL entries corresponding to that ID, or null on error
      * @type \DCarbone\PHPConsulAPI\QueryMeta query meta data
@@ -160,7 +160,7 @@ public function info($id, QueryOptions $queryOptions = null)
     }
 
     /**
-     * @param QueryOptions|null $queryOptions
+     * @param \DCarbone\PHPConsulAPI\QueryOptions|null $queryOptions
      * @return array(
      * @type \DCarbone\PHPConsulAPI\ACL\ACLEntry[] acl entries or null on error
      * @type \DCarbone\PHPConsulAPI\QueryMeta query meta data

diff --git a/src/Agent/AgentCheck.php b/src/Agent/AgentCheck.php
@@ -51,7 +51,7 @@ public function getNode()
 
     /**
      * @param string $Node
-     * @return AgentCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheck
      */
     public function setNode($Node)
     {
@@ -69,7 +69,7 @@ public function getCheckID()
 
     /**
      * @param string $CheckID
-     * @return AgentCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheck
      */
     public function setCheckID($CheckID)
     {
@@ -87,7 +87,7 @@ public function getName()
 
     /**
      * @param string $Name
-     * @return AgentCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheck
      */
     public function setName($Name)
     {
@@ -105,7 +105,7 @@ public function getStatus()
 
     /**
      * @param string $Status
-     * @return AgentCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheck
      */
     public function setStatus($Status)
     {
@@ -123,7 +123,7 @@ public function getNotes()
 
     /**
      * @param string $Notes
-     * @return AgentCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheck
      */
     public function setNotes($Notes)
     {
@@ -141,7 +141,7 @@ public function getOutput()
 
     /**
      * @param string $Output
-     * @return AgentCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheck
      */
     public function setOutput($Output)
     {
@@ -159,7 +159,7 @@ public function getServiceID()
 
     /**
      * @param string $ServiceID
-     * @return AgentCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheck
      */
     public function setServiceID($ServiceID)
     {
@@ -177,7 +177,7 @@ public function getServiceName()
 
     /**
      * @param string $ServiceName
-     * @return AgentCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheck
      */
     public function setServiceName($ServiceName)
     {

diff --git a/src/Agent/AgentCheckRegistration.php b/src/Agent/AgentCheckRegistration.php
@@ -41,7 +41,7 @@ public function getID()
 
     /**
      * @param string $ID
-     * @return AgentCheckRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheckRegistration
      */
     public function setID($ID)
     {
@@ -59,7 +59,7 @@ public function getName()
 
     /**
      * @param string $Name
-     * @return AgentCheckRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheckRegistration
      */
     public function setName($Name)
     {
@@ -77,7 +77,7 @@ public function getNotes()
 
     /**
      * @param string $Notes
-     * @return AgentCheckRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheckRegistration
      */
     public function setNotes($Notes)
     {
@@ -95,7 +95,7 @@ public function getServiceID()
 
     /**
      * @param string $ServiceID
-     * @return AgentCheckRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheckRegistration
      */
     public function setServiceID($ServiceID)
     {

diff --git a/src/Agent/AgentCheckUpdate.php b/src/Agent/AgentCheckUpdate.php
@@ -39,7 +39,7 @@ public function getStatus()
 
     /**
      * @param string $Status
-     * @return AgentCheckUpdate
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheckUpdate
      */
     public function setStatus($Status)
     {
@@ -57,7 +57,7 @@ public function getOutput()
 
     /**
      * @param string $Output
-     * @return AgentCheckUpdate
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentCheckUpdate
      */
     public function setOutput($Output)
     {

diff --git a/src/Agent/AgentClient.php b/src/Agent/AgentClient.php
@@ -167,8 +167,11 @@ public function members()
     /**
      * Register a service within Consul
      *
-     * @param AgentServiceRegistration $agentServiceRegistration
-     * @return \DCarbone\PHPConsulAPI\Error|null
+     * @param \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration $agentServiceRegistration
+     * @return array (
+     * @type \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration $agentServiceRegistration
+     * @type \DCarbone\PHPConsulAPI\Error|null
+     * )
      */
     public function serviceRegister(AgentServiceRegistration $agentServiceRegistration)
     {
@@ -248,8 +251,11 @@ public function updateTTL($checkID, $output, $status)
     }
 
     /**
-     * @param AgentCheckRegistration $agentCheckRegistration
-     * @return \DCarbone\PHPConsulAPI\Error|null
+     * @param \DCarbone\PHPConsulAPI\Agent\AgentCheckRegistration $agentCheckRegistration
+     * @return array (
+     * @type \DCarbone\PHPConsulAPI\Agent\AgentCheckRegistration $agentCheckRegistration
+     * @type \DCarbone\PHPConsulAPI\Error|null
+     * )
      */
     public function checkRegister(AgentCheckRegistration $agentCheckRegistration)
     {

diff --git a/src/Agent/AgentServiceCheck.php b/src/Agent/AgentServiceCheck.php
@@ -53,7 +53,7 @@ public function getScript()
 
     /**
      * @param string $Script
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setScript($Script)
     {
@@ -71,7 +71,7 @@ public function getDockerContainerID()
 
     /**
      * @param string $DockerContainerID
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setDockerContainerID($DockerContainerID)
     {
@@ -89,7 +89,7 @@ public function getShell()
 
     /**
      * @param string $Shell
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setShell($Shell)
     {
@@ -107,7 +107,7 @@ public function getInterval()
 
     /**
      * @param string $Interval
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setInterval($Interval)
     {
@@ -125,7 +125,7 @@ public function getTimeout()
 
     /**
      * @param string $Timeout
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setTimeout($Timeout)
     {
@@ -143,7 +143,7 @@ public function getTTL()
 
     /**
      * @param string $TTL
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setTTL($TTL)
     {
@@ -161,7 +161,7 @@ public function getHTTP()
 
     /**
      * @param string $HTTP
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setHTTP($HTTP)
     {
@@ -179,7 +179,7 @@ public function getTCP()
 
     /**
      * @param string $TCP
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setTCP($TCP)
     {
@@ -197,7 +197,7 @@ public function getStatus()
 
     /**
      * @param string $Status
-     * @return AgentServiceCheck
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceCheck
      */
     public function setStatus($Status)
     {

diff --git a/src/Agent/AgentServiceRegistration.php b/src/Agent/AgentServiceRegistration.php
@@ -78,7 +78,7 @@ public function getID()
 
     /**
      * @param string $ID
-     * @return AgentServiceRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration
      */
     public function setID($ID)
     {
@@ -96,7 +96,7 @@ public function getName()
 
     /**
      * @param string $Name
-     * @return AgentServiceRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration
      */
     public function setName($Name)
     {
@@ -114,7 +114,7 @@ public function getPort()
 
     /**
      * @param int $Port
-     * @return AgentServiceRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration
      */
     public function setPort($Port)
     {
@@ -132,7 +132,7 @@ public function getAddress()
 
     /**
      * @param string $Address
-     * @return AgentServiceRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration
      */
     public function setAddress($Address)
     {
@@ -150,7 +150,7 @@ public function isEnableTagOverride()
 
     /**
      * @param boolean $EnableTagOverride
-     * @return AgentServiceRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration
      */
     public function setEnableTagOverride($EnableTagOverride)
     {
@@ -168,7 +168,7 @@ public function getCheck()
 
     /**
      * @param \DCarbone\PHPConsulAPI\Agent\AgentCheck $Check
-     * @return AgentServiceRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration
      */
     public function setCheck(AgentCheck $Check)
     {
@@ -186,7 +186,7 @@ public function getChecks()
 
     /**
      * @param \DCarbone\PHPConsulAPI\Agent\AgentCheck[] $Checks
-     * @return AgentServiceRegistration
+     * @return \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration
      */
     public function setChecks(array $Checks)
     {

diff --git a/src/Catalog/CatalogClient.php b/src/Catalog/CatalogClient.php
@@ -28,7 +28,7 @@
 class CatalogClient extends AbstractClient
 {
     /**
-     * @param CatalogRegistration $catalogRegistration
+     * @param \DCarbone\PHPConsulAPI\Catalog\CatalogRegistration $catalogRegistration
      * @param \DCarbone\PHPConsulAPI\WriteOptions|null $writeOptions
      * @return array(
      *  @type \DCarbone\PHPConsulAPI\WriteMeta write meta data
@@ -48,7 +48,7 @@ public function register(CatalogRegistration $catalogRegistration, WriteOptions
     }
 
     /**
-     * @param CatalogDeregistration $catalogDeregistration
+     * @param \DCarbone\PHPConsulAPI\Catalog\CatalogDeregistration $catalogDeregistration
      * @param \DCarbone\PHPConsulAPI\WriteOptions|null $writeOptions
      * @return array(
      *  @type \DCarbone\PHPConsulAPI\WriteMeta write meta data