Documenting methods as internal or API

Author: jorgeborges

src/Analytics.php

@@ -467,6 +467,7 @@ public function __construct($isSsl = false)
     /**
      * Sets a request to be either synchronous or asynchronous (non-blocking).
      *
+     * @api
      * @param boolean $isAsyncRequest
      * @return $this
      */
@@ -494,6 +495,7 @@ public function makeNonBlocking()
     /**
      * Sets the HttpClient.
      *
+     * @internal
      * @param HttpClient $httpClient
      * @return $this
      */
@@ -533,6 +535,7 @@ private function getEndpoint()
     /**
      * Sets debug mode to true or false.
      *
+     * @api
      * @param bool $value
      * @return \TheIconic\Tracking\GoogleAnalytics\Analytics
      */
@@ -574,6 +577,7 @@ private function sendHit($methodName)
     /**
      * Build and returns URL used to send to Google Analytics.
      *
+     * @api
      * @return string
      */
     public function getUrl()

src/AnalyticsResponse.php

@@ -63,6 +63,7 @@ public function __construct(RequestInterface $request, $response)
      * Gets the HTTP status code.
      * It return NULL if the request was asynchronous since we are not waiting for the response.
      *
+     * @api
      * @return null|int
      */
     public function getHttpStatusCode()
@@ -73,6 +74,7 @@ public function getHttpStatusCode()
     /**
      * Gets the request URI used to get the response.
      *
+     * @api
      * @return string
      */
     public function getRequestUrl()
@@ -83,6 +85,7 @@ public function getRequestUrl()
     /**
      * Gets the debug response. Returns empty array if no response found.
      *
+     * @api
      * @return array
      */
     public function getDebugResponse()

src/Network/HttpClient.php

@@ -54,6 +54,7 @@ public function __destruct()
     /**
      * Sets HTTP client.
      *
+     * @internal
      * @param Client $client
      */
     public function setClient(Client $client)
@@ -80,6 +81,7 @@ private function getClient()
     /**
      * Sends request to Google Analytics.
      *
+     * @internal
      * @param string $url
      * @param boolean $nonBlocking
      * @return AnalyticsResponse

src/Network/PrepareUrl.php

@@ -28,6 +28,7 @@ class PrepareUrl
     /**
      * Build URL which is sent to Google Analytics
      *
+     * @internal
      * @param string $url
      * @param SingleParameter[] $singleParameters
      * @param CompoundParameterCollection[] $compoundParameters
@@ -49,6 +50,7 @@ public function build($url, array $singleParameters, array $compoundParameters)
     }
 
     /**
+     * @internal
      * @return array
      */
     public function getPayloadParameters()

src/Parameters/CompoundParameterCollection.php

@@ -51,6 +51,7 @@ public function add(CompoundParameter $compoundParameter)
     }
 
     /**
+     * @internal
      * @inheritDoc
      */
     public function getParametersArray()
@@ -73,6 +74,7 @@ public function getParametersArray()
     /**
      * Gets the human readable items for the parameter.
      *
+     * @internal
      * @return array
      */
     public function getReadableItems()
@@ -87,6 +89,7 @@ public function getReadableItems()
     }
 
     /**
+     * @internal
      * @inheritDoc
      */
     public function getIterator()

src/Parameters/CompoundParameterCollectionInterface.php

@@ -9,13 +9,15 @@ interface CompoundParameterCollectionInterface
     /**
      * Adds a compound parameter to the collection.
      *
+     * @internal
      * @param CompoundParameter $compoundParameter
      */
     public function add(CompoundParameter $compoundParameter);
 
     /**
      * Generates and returns all the payload parameters of compound parameters hold by the collection.
      *
+     * @internal
      * @return array
      */
     public function getParametersArray();

src/Parameters/CompoundParameterInterface.php

@@ -11,13 +11,15 @@ interface CompoundParameterInterface
     /**
      * Gets the payload parameters and their values.
      *
+     * @internal
      * @return array
      */
     public function getParameters();
 
     /**
      * Gets the parameters and their value in a human readable form.
      *
+     * @internal
      * @return array
      */
     public function getReadableParameters();

src/Parameters/SingleParameterInterface.php

@@ -11,13 +11,15 @@ interface SingleParameterInterface
     /**
      * Gets the name for the parameter.
      *
+     * @internal
      * @return string
      */
     public function getName();
 
     /**
      * Sets a value for the parameter.
      *
+     * @internal
      * @param $value
      * @return $this
      */
@@ -26,6 +28,7 @@ public function setValue($value);
     /**
      * Gets the value for the parameter.
      *
+     * @internal
      * @return mixed
      */
     public function getValue();