Fix doc blocks

This commit is contained in:
Romain Neutron 2013-06-25 10:40:20 +02:00
commit 0887d9088c
25 changed files with 58 additions and 52 deletions

View file

@ -45,7 +45,7 @@ abstract class DefaultAudio extends EventEmitter implements AudioInterface, Prog
/**
* Sets the audio codec, Should be in the available ones, otherwise an
* exception is thrown
* exception is thrown.
*
* @param string $audioCodec
*
@ -74,7 +74,7 @@ abstract class DefaultAudio extends EventEmitter implements AudioInterface, Prog
}
/**
* Sets the kiloBitrate value
* Sets the kiloBitrate value.
*
* @param integer $kiloBitrate
* @throws InvalidArgumentException

View file

@ -13,28 +13,28 @@ namespace FFMpeg\Format;
interface AudioInterface extends FormatInterface
{
/**
* Get the audio kiloBitrate value
* Gets the audio kiloBitrate value.
*
* @return integer
*/
public function getAudioKiloBitrate();
/**
* Return an array of extra parameters to add to ffmpeg commandline
* Returns an array of extra parameters to add to ffmpeg commandline.
*
* @return array()
*/
public function getExtraParams();
/**
* Returns the audio codec
* Returns the audio codec.
*
* @return string
*/
public function getAudioCodec();
/**
* Returns the list of available audio codecs for this format
* Returns the list of available audio codecs for this format.
*
* @return array
*/

View file

@ -18,7 +18,7 @@ use FFMpeg\Media\MediaTypeInterface;
interface ProgressableInterface extends EventEmitterInterface
{
/**
* Creates the progress listener
* Creates the progress listener.
*
* @param MediaTypeInterface $media
* @param FFProbe $ffprobe

View file

@ -41,7 +41,7 @@ abstract class DefaultVideo extends DefaultAudio implements VideoInterface
}
/**
* Sets the kiloBitrate value
* Sets the kiloBitrate value.
*
* @param integer $kiloBitrate
* @throws InvalidArgumentException
@ -67,7 +67,7 @@ abstract class DefaultVideo extends DefaultAudio implements VideoInterface
/**
* Sets the video codec, Should be in the available ones, otherwise an
* exception is thrown
* exception is thrown.
*
* @param string $videoCodec
* @throws InvalidArgumentException

View file

@ -14,14 +14,14 @@ namespace FFMpeg\Format;
interface VideoInterface extends AudioInterface
{
/**
* Get the kiloBitrate value
* Gets the kiloBitrate value.
*
* @return integer
*/
public function getKiloBitrate();
/**
* Returns the number of passes
* Returns the number of passes.
*
* @return string
*/
@ -40,14 +40,14 @@ interface VideoInterface extends AudioInterface
public function getModulus();
/**
* Returns the video codec
* Returns the video codec.
*
* @return string
*/
public function getVideoCodec();
/**
* Returns true if the current format supports B-Frames
* Returns true if the current format supports B-Frames.
*
* @see https://wikipedia.org/wiki/Video_compression_picture_types
*
@ -56,7 +56,7 @@ interface VideoInterface extends AudioInterface
public function supportBFrames();
/**
* Returns the list of available video codecs for this format
* Returns the list of available video codecs for this format.
*
* @return array
*/