blocktrail / blocktrail-sdk-php

src/BlocktrailSDKInterface.php

Doc Comments +14 added lines, -6 removed lines

@@ -9,6 +9,11 @@ 
  */
 interface BlocktrailSDKInterface {
 
+    /**
+     * @param string $apiSecret
+     *
+     * @return void
+     */
     public function __construct($apiKey, $apiSecret, $network = 'BTC', $testnet = false, $apiVersion = 'v1', $apiEndpoint = null);
 
     /**
@@ -17,6 +22,7 @@ 
      * @param   bool        $debug
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setCurlDebugging($debug = true);
 
@@ -26,6 +32,7 @@ 
      * @param   bool        $verboseErrors
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setVerboseErrors($verboseErrors = true);
     
@@ -35,6 +42,7 @@ 
      * @param bool      $value
      *
      * @codeCoverageIgnore
+     * @return void
      */
     public function setCurlDefaultOption($key, $value);
 
@@ -330,7 +338,7 @@ 
      *
      * @param string    $identifier             the wallet identifier to be upgraded
      * @param int       $keyIndex               the new account to use
-     * @param array     $primaryPublicKey       BIP32 extended public key - [key, path]
+     * @param string[]     $primaryPublicKey       BIP32 extended public key - [key, path]
      * @return mixed
      */
     public function upgradeKeyIndex($identifier, $keyIndex, $primaryPublicKey);
@@ -434,7 +442,7 @@ 
      *
      * @param string       $identifier     the identifier of the wallet
      * @param string|array $rawTransaction raw hex of the transaction (should be partially signed)
-     * @param array        $paths          list of the paths that were used for the UTXO
+     * @param string[]        $paths          list of the paths that were used for the UTXO
      * @param bool         $checkFee       let the server verify the fee after signing
      * @param null         $twoFactorToken
      * @return string                           the complete raw transaction
@@ -506,22 +514,22 @@ 
     /**
      * lock a specific unspent output
      *
-     * @param     $identifier
+     * @param     string $identifier
      * @param     $txHash
      * @param     $txIdx
      * @param int $ttl
      * @return
-     */
+     boolean
     public function lockWalletUTXO($identifier, $txHash, $txIdx, $ttl = 3);
 
     /**
      * unlock a specific unspent output
      *
-     * @param     $identifier
+     * @param     string $identifier
      * @param     $txHash
      * @param     $txIdx
      * @return
-     */
+     boolean
     public function unlockWalletUTXO($identifier, $txHash, $txIdx);
 
     /**