Fix docs generation, PSR-12 type compliance (#790)

* Correct docs generation, fixes #774

* Standardise on unaliased int and bool types, as per PSR-12 section 2.5
This commit is contained in:
Marcus Bointon 2021-03-02 15:39:45 +01:00 committed by GitHub
commit 8f7575b076
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
29 changed files with 58 additions and 60 deletions

View file

@ -24,10 +24,10 @@ abstract class DefaultAudio extends EventEmitter implements AudioInterface, Prog
/** @var string */
protected $audioCodec;
/** @var integer */
/** @var int */
protected $audioKiloBitrate = 128;
/** @var integer */
/** @var int */
protected $audioChannels = null;
/**
@ -79,7 +79,7 @@ abstract class DefaultAudio extends EventEmitter implements AudioInterface, Prog
/**
* Sets the kiloBitrate value.
*
* @param integer $kiloBitrate
* @param int $kiloBitrate
* @throws InvalidArgumentException
*/
public function setAudioKiloBitrate($kiloBitrate)
@ -104,7 +104,7 @@ abstract class DefaultAudio extends EventEmitter implements AudioInterface, Prog
/**
* Sets the channels value.
*
* @param integer $channels
* @param int $channels
* @throws InvalidArgumentException
*/
public function setAudioChannels($channels)

View file

@ -15,14 +15,14 @@ interface AudioInterface extends FormatInterface
/**
* Gets the audio kiloBitrate value.
*
* @return integer
* @return int
*/
public function getAudioKiloBitrate();
/**
* Gets the audio channels value.
*
* @return integer
* @return int
*/
public function getAudioChannels();

View file

@ -22,7 +22,7 @@ interface FormatInterface
/**
* Returns an array of extra parameters to add to ffmpeg commandline.
*
* @return array()
* @return array
*/
public function getExtraParams();
}

View file

@ -21,16 +21,16 @@ use FFMpeg\Exception\RuntimeException;
*/
abstract class AbstractProgressListener extends EventEmitter implements ListenerInterface
{
/** @var integer */
/** @var int */
private $duration;
/** @var integer */
/** @var int */
private $totalSize;
/** @var integer */
/** @var int */
private $currentSize;
/** @var integer */
/** @var int */
private $currentTime;
/** @var double */
@ -45,40 +45,39 @@ abstract class AbstractProgressListener extends EventEmitter implements Listener
/** @var bool */
private $initialized = false;
/** @var integer */
/** @var int */
private $currentPass;
/** @var integer */
/** @var int */
private $totalPass;
/**
* Transcoding rate in kb/s
*
* @var integer
* @var int
*/
private $rate;
/**
* Percentage of transcoding progress (0 - 100)
*
* @var integer
* @var int
*/
private $percent = 0;
/**
* Time remaining (seconds)
*
* @var integer
* @var int
*/
private $remaining = null;
/**
* @param FFProbe $ffprobe
* @param string $pathfile
* @param integer $currentPass The cureent pass number
* @param integer $totalPass The total number of passes
*
* @throws RuntimeException
* @param string $pathfile
* @param int $currentPass The current pass number
* @param int $totalPass The total number of passes
* @param int $duration
*/
public function __construct(FFProbe $ffprobe, $pathfile, $currentPass, $totalPass, $duration = 0)
{
@ -106,7 +105,7 @@ abstract class AbstractProgressListener extends EventEmitter implements Listener
}
/**
* @return integer
* @return int
*/
public function getCurrentPass()
{
@ -114,7 +113,7 @@ abstract class AbstractProgressListener extends EventEmitter implements Listener
}
/**
* @return integer
* @return int
*/
public function getTotalPass()
{

View file

@ -49,7 +49,7 @@ abstract class DefaultVideo extends DefaultAudio implements VideoInterface
/**
* Sets the kiloBitrate value.
*
* @param integer $kiloBitrate
* @param int $kiloBitrate
* @throws InvalidArgumentException
*/
public function setKiloBitrate($kiloBitrate)
@ -93,7 +93,7 @@ abstract class DefaultVideo extends DefaultAudio implements VideoInterface
}
/**
* @return integer
* @return int
*/
public function getModulus()
{

View file

@ -16,10 +16,10 @@ namespace FFMpeg\Format\Video;
*/
class X264 extends DefaultVideo
{
/** @var boolean */
/** @var bool */
private $bframesSupport = true;
/** @var integer */
/** @var int */
private $passes = 2;
public function __construct($audioCodec = 'libfaac', $videoCodec = 'libx264')

View file

@ -16,7 +16,7 @@ interface VideoInterface extends AudioInterface
/**
* Gets the kiloBitrate value.
*
* @return integer
* @return int
*/
public function getKiloBitrate();
@ -28,7 +28,7 @@ interface VideoInterface extends AudioInterface
*
* @see http://www.undeadborn.net/tools/rescalculator.php
*
* @return integer
* @return int
*/
public function getModulus();