Corrected function documentation - added missing parameters or correc…

…ted misspelled ones
bambora-na · Oct 1, 2015 · 121a476 · 121a476
1 parent 63e49b6
commit 121a476
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 6 deletions.
diff --git a/src/Beanstream/Configuration.php b/src/Beanstream/Configuration.php
@@ -35,12 +35,13 @@ class Configuration {
      */
 	protected $_apiKey;
 
-	/**
-	 * setMerchantId() function
+	/**
+	 * setMerchantId() function
+	 *
+	 * @param string $merchantId
 	 *
-	 * @param string $merchantId
-	 * @return void
-	 */
+	 * @throws ConfigurationException
+	 */
 	public function setMerchantId($merchantId = '') {
 		//check to make sure string strlen is 9 containing only digits 0-9
 		if (!preg_match('/^[0-9]{9}$/', $merchantId)) { //TODO switch to actual real assertmerchantId

diff --git a/src/Beanstream/api/Payments.php b/src/Beanstream/api/Payments.php
@@ -256,7 +256,9 @@ public function makeProfilePayment($profile_id, $card_id, $data, $complete = TRU
      * @link http://developer.beanstream.com/documentation/legato/server-to-server-integration-by-api/
      * 
      * @param array $data Order data
+     *
      * @return string Legato token
+     * @throws ApiException
      */
 	public function getTokenTest($data = NULL) {
 

diff --git a/src/Beanstream/api/Profiles.php b/src/Beanstream/api/Profiles.php
@@ -168,6 +168,8 @@ public function addCard($profile_id, $data)
      * 
      * @param string $profile_id Profile Id
      * @param string $card_id Card Id
+     * @param array $data Card data
+     *
      * @return array Result
      */
     public function updateCard($profile_id, $card_id, $data) {

diff --git a/src/Beanstream/communications/HttpConnector.php b/src/Beanstream/communications/HttpConnector.php
@@ -29,7 +29,7 @@ function __construct($auth) {
      * processTransaction() function - Public facing function to send a request to an endpoint.
      * 
      * @param	string	$http_method HTTP method to use (defaults to GET if $data==null; defaults to PUT if $data!=null)
-     * @param	string	$url	Incoming API Endpoint
+     * @param	string	$endpoint Incoming API Endpoint
 	 * @param	array 	$data Data for POST requests, not needed for GETs
      * @access	public
 	 * @return	array	Parsed API response from private request method
@@ -50,6 +50,8 @@ public function processTransaction($http_method, $endpoint, $data) {
      * @access	private
 	 * @return	array Parsed API response
 	 * 
+     * @throws ApiException
+     * @throws ConnectorException
      */
     private function request($http_method = NULL, $url, $data = NULL)
     {