octoleo/phpseclib
1
0
Fork 0
mirror of https://github.com/phpseclib/phpseclib.git synced 2024-12-30 12:50:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed invalid param phpdoc

Browse Source
This commit is contained in:
Graham Campbell 2015-09-02 00:41:38 +01:00
parent 0f1d043428
commit c08c099c56
12 changed files with 66 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
phpseclib/Crypt/Base.php
View File

@ -461,7 +461,7 @@ abstract class Base
* *
* If not explicitly set, self::MODE_CBC will be used. * If not explicitly set, self::MODE_CBC will be used.
* *
* @param optional Integer $mode * @param Integer $mode
* @access public * @access public
*/ */
function __construct($mode = self::MODE_CBC) function __construct($mode = self::MODE_CBC)
@ -544,7 +544,7 @@ abstract class Base
* *
* @see Crypt/Hash.php * @see Crypt/Hash.php
* @param String $password * @param String $password
* @param optional String $method * @param String $method
* @return Boolean * @return Boolean
* @access public * @access public
* @internal Could, but not must, extend by the child Crypt_* class * @internal Could, but not must, extend by the child Crypt_* class
@ -1840,7 +1840,7 @@ abstract class Base
* Inspired by array_shift * Inspired by array_shift
* *
* @param String $string * @param String $string
* @param optional Integer $index * @param Integer $index
* @access private * @access private
* @return String * @return String
*/ */
@ -1857,7 +1857,7 @@ abstract class Base
* Inspired by array_pop * Inspired by array_pop
* *
* @param String $string * @param String $string
* @param optional Integer $index * @param Integer $index
* @access private * @access private
* @return String * @return String
*/ */

6
phpseclib/Crypt/Hash.php
View File

@ -133,7 +133,7 @@ class Hash
/** /**
* Default Constructor. * Default Constructor.
* *
* @param optional String $hash * @param String $hash
* @return \phpseclib\Crypt\Hash * @return \phpseclib\Crypt\Hash
* @access public * @access public
*/ */
@ -161,7 +161,7 @@ class Hash
* Keys can be of any length. * Keys can be of any length.
* *
* @access public * @access public
* @param optional String $key * @param String $key
*/ */
function setKey($key = false) function setKey($key = false)
{ {
@ -812,7 +812,7 @@ class Hash
* Inspired by array_shift * Inspired by array_shift
* *
* @param String $string * @param String $string
* @param optional Integer $index * @param Integer $index
* @return String * @return String
* @access private * @access private
*/ */

8
phpseclib/Crypt/RSA.php
View File

@ -537,9 +537,9 @@ class RSA
* Will need to be passed back to \phpseclib\Crypt\RSA::createKey() as the third parameter for further processing. * Will need to be passed back to \phpseclib\Crypt\RSA::createKey() as the third parameter for further processing.
* *
* @access public * @access public
* @param optional Integer $bits * @param Integer $bits
* @param optional Integer $timeout * @param Integer $timeout
* @param optional array $p * @param array $p
*/ */
function createKey($bits = 1024, $timeout = false, $partial = array()) function createKey($bits = 1024, $timeout = false, $partial = array())
{ {
@ -1942,7 +1942,7 @@ class RSA
* Inspired by array_shift * Inspired by array_shift
* *
* @param String $string * @param String $string
* @param optional Integer $index * @param Integer $index
* @return String * @return String
* @access private * @access private
*/ */

2
phpseclib/Crypt/Rijndael.php
View File

@ -209,7 +209,7 @@ class Rijndael extends Base
* If not explictly set, \phpseclib\Crypt\Base::MODE_CBC will be used. * If not explictly set, \phpseclib\Crypt\Base::MODE_CBC will be used.
* *
* @see \phpseclib\Crypt\Base::Crypt_Base() * @see \phpseclib\Crypt\Base::Crypt_Base()
* @param optional Integer $mode * @param Integer $mode
* @access public * @access public
/** /**

2
phpseclib/Crypt/TripleDES.php
View File

@ -154,7 +154,7 @@ class TripleDES extends DES
* *
* @see \phpseclib\Crypt\DES::__construct() * @see \phpseclib\Crypt\DES::__construct()
* @see \phpseclib\Crypt\Base::__construct() * @see \phpseclib\Crypt\Base::__construct()
* @param optional Integer $mode * @param Integer $mode
* @access public * @access public
*/ */
function __construct($mode = Base::MODE_CBC) function __construct($mode = Base::MODE_CBC)

6
phpseclib/File/ASN1.php
View File

@ -1196,7 +1196,7 @@ class ASN1
* Inspired by array_shift * Inspired by array_shift
* *
* @param String $string * @param String $string
* @param optional Integer $index * @param Integer $index
* @return String * @return String
* @access private * @access private
*/ */
@ -1214,8 +1214,8 @@ class ASN1
* No real conversion table is used. * No real conversion table is used.
* *
* @param String $in * @param String $in
* @param optional Integer $from * @param Integer $from
* @param optional Integer $to * @param Integer $to
* @return String * @return String
* @access public * @access public
*/ */

12
phpseclib/Math/BigInteger.php
View File

@ -251,8 +251,8 @@ class BigInteger
* ?> * ?>
* </code> * </code>
* *
* @param optional $x base-10 number or base-$base number if $base set. * @param $x base-10 number or base-$base number if $base set.
* @param optional integer $base * @param integer $base
* @return \phpseclib\Math\BigInteger * @return \phpseclib\Math\BigInteger
* @access public * @access public
*/ */
@ -3076,7 +3076,7 @@ class BigInteger
* $max->random($min) * $max->random($min)
* *
* @param \phpseclib\Math\BigInteger $arg1 * @param \phpseclib\Math\BigInteger $arg1
* @param optional \phpseclib\Math\BigInteger $arg2 * @param \phpseclib\Math\BigInteger $arg2
* @return \phpseclib\Math\BigInteger * @return \phpseclib\Math\BigInteger
* @access public * @access public
* @internal The API for creating random numbers used to be $a->random($min, $max), where $a was a BigInteger object. * @internal The API for creating random numbers used to be $a->random($min, $max), where $a was a BigInteger object.
@ -3157,8 +3157,8 @@ class BigInteger
* give up and return false. * give up and return false.
* *
* @param \phpseclib\Math\BigInteger $arg1 * @param \phpseclib\Math\BigInteger $arg1
* @param optional \phpseclib\Math\BigInteger $arg2 * @param \phpseclib\Math\BigInteger $arg2
* @param optional Integer $timeout * @param Integer $timeout
* @return Mixed * @return Mixed
* @access public * @access public
* @internal See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap4.pdf#page=15 HAC 4.44}. * @internal See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap4.pdf#page=15 HAC 4.44}.
@ -3286,7 +3286,7 @@ class BigInteger
* $t parameter is distributability. BigInteger::randomPrime() can be distributed across multiple pageloads * $t parameter is distributability. BigInteger::randomPrime() can be distributed across multiple pageloads
* on a website instead of just one. * on a website instead of just one.
* *
* @param optional \phpseclib\Math\BigInteger $t * @param \phpseclib\Math\BigInteger $t
* @return Boolean * @return Boolean
* @access public * @access public
* @internal Uses the * @internal Uses the

10
phpseclib/Net/SCP.php
View File

@ -103,8 +103,8 @@ class SCP
* Connects to an SSH server * Connects to an SSH server
* *
* @param String $host * @param String $host
* @param optional Integer $port * @param Integer $port
* @param optional Integer $timeout * @param Integer $timeout
* @return \phpseclib\Net\SCP * @return \phpseclib\Net\SCP
* @access public * @access public
*/ */
@ -138,8 +138,8 @@ class SCP
* *
* @param String $remote_file * @param String $remote_file
* @param String $data * @param String $data
* @param optional Integer $mode * @param Integer $mode
* @param optional Callable $callback * @param Callable $callback
* @return Boolean * @return Boolean
* @access public * @access public
*/ */
@ -213,7 +213,7 @@ class SCP
* operation * operation
* *
* @param String $remote_file * @param String $remote_file
* @param optional String $local_file * @param String $local_file
* @return Mixed * @return Mixed
* @access public * @access public
*/ */

42
phpseclib/Net/SFTP.php
View File

@ -244,8 +244,8 @@ class SFTP extends SSH2
* Connects to an SFTP server * Connects to an SFTP server
* *
* @param String $host * @param String $host
* @param optional Integer $port * @param Integer $port
* @param optional Integer $timeout * @param Integer $timeout
* @return \phpseclib\Net\SFTP * @return \phpseclib\Net\SFTP
* @access public * @access public
*/ */
@ -382,7 +382,7 @@ class SFTP extends SSH2
* Login * Login
* *
* @param String $username * @param String $username
* @param optional String $password * @param String $password
* @return Boolean * @return Boolean
* @access public * @access public
*/ */
@ -583,7 +583,7 @@ class SFTP extends SSH2
* Logs errors * Logs errors
* *
* @param String $response * @param String $response
* @param optional Integer $status * @param Integer $status
* @access public * @access public
*/ */
function _logError($response, $status = -1) function _logError($response, $status = -1)
@ -727,8 +727,8 @@ class SFTP extends SSH2
/** /**
* Returns a list of files in the given directory * Returns a list of files in the given directory
* *
* @param optional String $dir * @param String $dir
* @param optional Boolean $recursive * @param Boolean $recursive
* @return Mixed * @return Mixed
* @access public * @access public
*/ */
@ -776,8 +776,8 @@ class SFTP extends SSH2
/** /**
* Returns a detailed list of files in the given directory * Returns a detailed list of files in the given directory
* *
* @param optional String $dir * @param String $dir
* @param optional Boolean $recursive * @param Boolean $recursive
* @return Mixed * @return Mixed
* @access public * @access public
*/ */
@ -811,7 +811,7 @@ class SFTP extends SSH2
* Reads a list, be it detailed or not, of files in the given directory * Reads a list, be it detailed or not, of files in the given directory
* *
* @param String $dir * @param String $dir
* @param optional Boolean $raw * @param Boolean $raw
* @return Mixed * @return Mixed
* @access private * @access private
*/ */
@ -1304,8 +1304,8 @@ class SFTP extends SSH2
* If the file does not exist, it will be created. * If the file does not exist, it will be created.
* *
* @param String $filename * @param String $filename
* @param optional Integer $time * @param Integer $time
* @param optional Integer $atime * @param Integer $atime
* @return Boolean * @return Boolean
* @access public * @access public
*/ */
@ -1356,7 +1356,7 @@ class SFTP extends SSH2
* *
* @param String $filename * @param String $filename
* @param Integer $uid * @param Integer $uid
* @param optional Boolean $recursive * @param Boolean $recursive
* @return Boolean * @return Boolean
* @access public * @access public
*/ */
@ -1376,7 +1376,7 @@ class SFTP extends SSH2
* *
* @param String $filename * @param String $filename
* @param Integer $gid * @param Integer $gid
* @param optional Boolean $recursive * @param Boolean $recursive
* @return Boolean * @return Boolean
* @access public * @access public
*/ */
@ -1395,7 +1395,7 @@ class SFTP extends SSH2
* *
* @param Integer $mode * @param Integer $mode
* @param String $filename * @param String $filename
* @param optional Boolean $recursive * @param Boolean $recursive
* @return Mixed * @return Mixed
* @access public * @access public
*/ */
@ -1790,10 +1790,10 @@ class SFTP extends SSH2
* *
* @param String $remote_file * @param String $remote_file
* @param String|resource $data * @param String|resource $data
* @param optional Integer $mode * @param Integer $mode
* @param optional Integer $start * @param Integer $start
* @param optional Integer $local_start * @param Integer $local_start
* @param optional callable|null $progressCallback * @param callable|null $progressCallback
* @return Boolean * @return Boolean
* @access public * @access public
* @internal ASCII mode for SFTPv4/5/6 can be supported by adding a new function - \phpseclib\Net\SFTP::setMode(). * @internal ASCII mode for SFTPv4/5/6 can be supported by adding a new function - \phpseclib\Net\SFTP::setMode().
@ -2011,9 +2011,9 @@ class SFTP extends SSH2
* $offset and $length can be used to download files in chunks. * $offset and $length can be used to download files in chunks.
* *
* @param String $remote_file * @param String $remote_file
* @param optional String $local_file * @param String $local_file
* @param optional Integer $offset * @param Integer $offset
* @param optional Integer $length * @param Integer $length
* @return Mixed * @return Mixed
* @access public * @access public
*/ */

2
phpseclib/Net/SFTP/Stream.php
View File

@ -115,7 +115,7 @@ class Stream
/** /**
* Registers this class as a URL wrapper. * Registers this class as a URL wrapper.
* *
* @param optional String $protocol The wrapper name to be registered. * @param String $protocol The wrapper name to be registered.
* @return Boolean True on success, false otherwise. * @return Boolean True on success, false otherwise.
* @access public * @access public
*/ */

22
phpseclib/Net/SSH1.php
View File

@ -498,9 +498,9 @@ class SSH1
* Connects to an SSHv1 server * Connects to an SSHv1 server
* *
* @param String $host * @param String $host
* @param optional Integer $port * @param Integer $port
* @param optional Integer $timeout * @param Integer $timeout
* @param optional Integer $cipher * @param Integer $cipher
* @return \phpseclib\Net\SSH1 * @return \phpseclib\Net\SSH1
* @access public * @access public
*/ */
@ -695,7 +695,7 @@ class SSH1
* Login * Login
* *
* @param String $username * @param String $username
* @param optional String $password * @param String $password
* @return Boolean * @return Boolean
* @access public * @access public
*/ */
@ -1285,7 +1285,7 @@ class SSH1
* Inspired by array_shift * Inspired by array_shift
* *
* @param String $string * @param String $string
* @param optional Integer $index * @param Integer $index
* @return String * @return String
* @access private * @access private
*/ */
@ -1451,7 +1451,7 @@ class SSH1
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead, * Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function. * the raw bytes. This behavior is similar to PHP's md5() function.
* *
* @param optional Boolean $raw_output * @param Boolean $raw_output
* @return String * @return String
* @access public * @access public
*/ */
@ -1466,7 +1466,7 @@ class SSH1
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead, * Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function. * the raw bytes. This behavior is similar to PHP's md5() function.
* *
* @param optional Boolean $raw_output * @param Boolean $raw_output
* @return String * @return String
* @access public * @access public
*/ */
@ -1481,7 +1481,7 @@ class SSH1
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead, * Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function. * the raw bytes. This behavior is similar to PHP's md5() function.
* *
* @param optional Boolean $raw_output * @param Boolean $raw_output
* @return String * @return String
* @access public * @access public
*/ */
@ -1496,7 +1496,7 @@ class SSH1
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead, * Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function. * the raw bytes. This behavior is similar to PHP's md5() function.
* *
* @param optional Boolean $raw_output * @param Boolean $raw_output
* @return String * @return String
* @access public * @access public
*/ */
@ -1512,7 +1512,7 @@ class SSH1
* is set to true, returns, instead, an array of constants. ie. instead of array('Triple-DES in CBC mode'), you'll * is set to true, returns, instead, an array of constants. ie. instead of array('Triple-DES in CBC mode'), you'll
* get array(self::CIPHER_3DES). * get array(self::CIPHER_3DES).
* *
* @param optional Boolean $raw_output * @param Boolean $raw_output
* @return Array * @return Array
* @access public * @access public
*/ */
@ -1528,7 +1528,7 @@ class SSH1
* is set to true, returns, instead, an array of constants. ie. instead of array('password authentication'), you'll * is set to true, returns, instead, an array of constants. ie. instead of array('password authentication'), you'll
* get array(self::AUTH_PASSWORD). * get array(self::AUTH_PASSWORD).
* *
* @param optional Boolean $raw_output * @param Boolean $raw_output
* @return Array * @return Array
* @access public * @access public
*/ */

12
phpseclib/Net/SSH2.php
View File

@ -872,8 +872,8 @@ class SSH2
* $host can either be a string, representing the host, or a stream resource. * $host can either be a string, representing the host, or a stream resource.
* *
* @param Mixed $host * @param Mixed $host
* @param optional Integer $port * @param Integer $port
* @param optional Integer $timeout * @param Integer $timeout
* @see \phpseclib\Net\SSH2::login() * @see \phpseclib\Net\SSH2::login()
* @return \phpseclib\Net\SSH2 * @return \phpseclib\Net\SSH2
* @access public * @access public
@ -1889,7 +1889,7 @@ class SSH2
* Login Helper * Login Helper
* *
* @param String $username * @param String $username
* @param optional String $password * @param String $password
* @return Boolean * @return Boolean
* @access private * @access private
* @internal It might be worthwhile, at some point, to protect against {@link http://tools.ietf.org/html/rfc4251#section-9.3.9 traffic analysis} * @internal It might be worthwhile, at some point, to protect against {@link http://tools.ietf.org/html/rfc4251#section-9.3.9 traffic analysis}
@ -2361,7 +2361,7 @@ class SSH2
* In all likelihood, this is not a feature you want to be taking advantage of. * In all likelihood, this is not a feature you want to be taking advantage of.
* *
* @param String $command * @param String $command
* @param optional Callback $callback * @param Callback $callback
* @return String * @return String
* @access public * @access public
*/ */
@ -3376,7 +3376,7 @@ class SSH2
* See '6. Binary Packet Protocol' of rfc4253 for more info. * See '6. Binary Packet Protocol' of rfc4253 for more info.
* *
* @param String $data * @param String $data
* @param optional String $logged * @param String $logged
* @see \phpseclib\Net\SSH2::_get_binary_packet() * @see \phpseclib\Net\SSH2::_get_binary_packet()
* @return Boolean * @return Boolean
* @access private * @access private
@ -3615,7 +3615,7 @@ class SSH2
* Inspired by array_shift * Inspired by array_shift
* *
* @param String $string * @param String $string
* @param optional Integer $index * @param Integer $index
* @return String * @return String
* @access private * @access private
*/ */