octoleo/phpseclib
1
0
Fork 0
mirror of https://github.com/phpseclib/phpseclib.git synced 2025-02-09 23:28:33 +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:22:30 +01:00
parent e391fdbd27
commit 5890f3da98
13 changed files with 67 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
phpseclib/Crypt/Base.php
View File

@ -491,7 +491,7 @@ class Crypt_Base
* *
* If not explicitly set, CRYPT_MODE_CBC will be used. * If not explicitly set, CRYPT_MODE_CBC will be used.
* *
* @param optional Integer $mode * @param Integer $mode
* @access public * @access public
*/ */
function Crypt_Base($mode = CRYPT_MODE_CBC) function Crypt_Base($mode = CRYPT_MODE_CBC)
@ -574,7 +574,7 @@ class Crypt_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
@ -1882,7 +1882,7 @@ class Crypt_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
*/ */
@ -1899,7 +1899,7 @@ class Crypt_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

@ -147,7 +147,7 @@ class Crypt_Hash
/** /**
* Default Constructor. * Default Constructor.
* *
* @param optional String $hash * @param String $hash
* @return Crypt_Hash * @return Crypt_Hash
* @access public * @access public
*/ */
@ -175,7 +175,7 @@ class Crypt_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)
{ {
@ -830,7 +830,7 @@ class Crypt_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
*/ */

2
phpseclib/Crypt/RC2.php
View File

@ -344,7 +344,7 @@ class Crypt_RC2 extends Crypt_Base
* If not explicitly set, CRYPT_RC2_MODE_CBC will be used. * If not explicitly set, CRYPT_RC2_MODE_CBC will be used.
* *
* @see Crypt_Base::Crypt_Base() * @see Crypt_Base::Crypt_Base()
* @param optional Integer $mode * @param Integer $mode
* @access public * @access public
*/ */
function Crypt_RC2($mode = CRYPT_RC2_MODE_CBC) function Crypt_RC2($mode = CRYPT_RC2_MODE_CBC)

8
phpseclib/Crypt/RSA.php
View File

@ -571,9 +571,9 @@ class Crypt_RSA
* Will need to be passed back to Crypt_RSA::createKey() as the third parameter for further processing. * Will need to be passed back to 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 Math_BigInteger $p * @param Math_BigInteger $p
*/ */
function createKey($bits = 1024, $timeout = false, $partial = array()) function createKey($bits = 1024, $timeout = false, $partial = array())
{ {
@ -2009,7 +2009,7 @@ class Crypt_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

@ -280,7 +280,7 @@ class Crypt_Rijndael extends Crypt_Base
* If not explictly set, CRYPT_RIJNDAEL_MODE_CBC will be used. * If not explictly set, CRYPT_RIJNDAEL_MODE_CBC will be used.
* *
* @see Crypt_Base::Crypt_Base() * @see Crypt_Base::Crypt_Base()
* @param optional Integer $mode * @param Integer $mode
* @access public * @access public
*/ */
function Crypt_Rijndael($mode = CRYPT_RIJNDAEL_MODE_CBC) function Crypt_Rijndael($mode = CRYPT_RIJNDAEL_MODE_CBC)

2
phpseclib/Crypt/TripleDES.php
View File

@ -195,7 +195,7 @@ class Crypt_TripleDES extends Crypt_DES
* *
* @see Crypt_DES::Crypt_DES() * @see Crypt_DES::Crypt_DES()
* @see Crypt_Base::Crypt_Base() * @see Crypt_Base::Crypt_Base()
* @param optional Integer $mode * @param Integer $mode
* @access public * @access public
*/ */
function Crypt_TripleDES($mode = CRYPT_MODE_CBC) function Crypt_TripleDES($mode = CRYPT_MODE_CBC)

6
phpseclib/File/ASN1.php
View File

@ -1257,7 +1257,7 @@ class File_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
*/ */
@ -1275,8 +1275,8 @@ class File_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

@ -246,8 +246,8 @@ class Math_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 Math_BigInteger * @return Math_BigInteger
* @access public * @access public
*/ */
@ -3113,7 +3113,7 @@ class Math_BigInteger
* $max->random($min) * $max->random($min)
* *
* @param Math_BigInteger $arg1 * @param Math_BigInteger $arg1
* @param optional Math_BigInteger $arg2 * @param Math_BigInteger $arg2
* @return Math_BigInteger * @return Math_BigInteger
* @access public * @access public
* @internal The API for creating random numbers used to be $a->random($min, $max), where $a was a Math_BigInteger object. * @internal The API for creating random numbers used to be $a->random($min, $max), where $a was a Math_BigInteger object.
@ -3194,8 +3194,8 @@ class Math_BigInteger
* give up and return false. * give up and return false.
* *
* @param Math_BigInteger $arg1 * @param Math_BigInteger $arg1
* @param optional Math_BigInteger $arg2 * @param 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}.
@ -3323,7 +3323,7 @@ class Math_BigInteger
* $t parameter is distributability. Math_BigInteger::randomPrime() can be distributed across multiple pageloads * $t parameter is distributability. Math_BigInteger::randomPrime() can be distributed across multiple pageloads
* on a website instead of just one. * on a website instead of just one.
* *
* @param optional Math_BigInteger $t * @param Math_BigInteger $t
* @return Boolean * @return Boolean
* @access public * @access public
* @internal Uses the * @internal Uses the

10
phpseclib/Net/SCP.php
View File

@ -117,8 +117,8 @@ class Net_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 Net_SCP * @return Net_SCP
* @access public * @access public
*/ */
@ -159,8 +159,8 @@ class Net_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
*/ */
@ -234,7 +234,7 @@ class Net_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

@ -283,8 +283,8 @@ class Net_SFTP extends Net_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 Net_SFTP * @return Net_SFTP
* @access public * @access public
*/ */
@ -421,7 +421,7 @@ class Net_SFTP extends Net_SSH2
* Login * Login
* *
* @param String $username * @param String $username
* @param optional String $password * @param String $password
* @return Boolean * @return Boolean
* @access public * @access public
*/ */
@ -622,7 +622,7 @@ class Net_SFTP extends Net_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)
@ -766,8 +766,8 @@ class Net_SFTP extends Net_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
*/ */
@ -815,8 +815,8 @@ class Net_SFTP extends Net_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
*/ */
@ -850,7 +850,7 @@ class Net_SFTP extends Net_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
*/ */
@ -1343,8 +1343,8 @@ class Net_SFTP extends Net_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
*/ */
@ -1395,7 +1395,7 @@ class Net_SFTP extends Net_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
*/ */
@ -1415,7 +1415,7 @@ class Net_SFTP extends Net_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
*/ */
@ -1434,7 +1434,7 @@ class Net_SFTP extends Net_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
*/ */
@ -1831,10 +1831,10 @@ class Net_SFTP extends Net_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 - Net_SFTP::setMode(). * @internal ASCII mode for SFTPv4/5/6 can be supported by adding a new function - Net_SFTP::setMode().
@ -2052,9 +2052,9 @@ class Net_SFTP extends Net_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

@ -128,7 +128,7 @@ class Net_SFTP_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

@ -509,9 +509,9 @@ class Net_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 Net_SSH1 * @return Net_SSH1
* @access public * @access public
*/ */
@ -728,7 +728,7 @@ class Net_SSH1
* Login * Login
* *
* @param String $username * @param String $username
* @param optional String $password * @param String $password
* @return Boolean * @return Boolean
* @access public * @access public
*/ */
@ -1318,7 +1318,7 @@ class Net_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
*/ */
@ -1488,7 +1488,7 @@ class Net_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
*/ */
@ -1503,7 +1503,7 @@ class Net_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
*/ */
@ -1518,7 +1518,7 @@ class Net_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
*/ */
@ -1533,7 +1533,7 @@ class Net_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
*/ */
@ -1549,7 +1549,7 @@ class Net_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(NET_SSH1_CIPHER_3DES). * get array(NET_SSH1_CIPHER_3DES).
* *
* @param optional Boolean $raw_output * @param Boolean $raw_output
* @return Array * @return Array
* @access public * @access public
*/ */
@ -1565,7 +1565,7 @@ class Net_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(NET_SSH1_AUTH_PASSWORD). * get array(NET_SSH1_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

@ -877,8 +877,8 @@ class Net_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 Net_SSH2::login() * @see Net_SSH2::login()
* @return Net_SSH2 * @return Net_SSH2
* @access public * @access public
@ -1986,7 +1986,7 @@ class Net_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}
@ -2462,7 +2462,7 @@ class Net_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
*/ */
@ -3478,7 +3478,7 @@ class Net_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 Net_SSH2::_get_binary_packet() * @see Net_SSH2::_get_binary_packet()
* @return Boolean * @return Boolean
* @access private * @access private
@ -3717,7 +3717,7 @@ class Net_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
*/ */