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

@ -23,7 +23,7 @@ abstract class AbstractData implements \Countable
}
/**
* Returns true if data has property
* Returns true if data has property.
*
* @param string $property
* @return Boolean
@ -34,7 +34,7 @@ abstract class AbstractData implements \Countable
}
/**
* Returns the property value given its name
* Returns the property value given its name.
*
* @param string $property
* @return mixed
@ -51,7 +51,7 @@ abstract class AbstractData implements \Countable
}
/**
* Returns all property names
* Returns all property names.
*
* @return array
*/
@ -61,7 +61,7 @@ abstract class AbstractData implements \Countable
}
/**
* Returns all properties and their values
* Returns all properties and their values.
*
* @return array
*/

View file

@ -14,7 +14,7 @@ namespace FFMpeg\FFProbe\DataMapping;
class Stream extends AbstractData
{
/**
* Returns true if the stream is an audio stream
* Returns true if the stream is an audio stream.
*
* @return Boolean
*/
@ -24,7 +24,7 @@ class Stream extends AbstractData
}
/**
* Returns true if the stream is a video stream
* Returns true if the stream is a video stream.
*
* @return Boolean
*/

View file

@ -34,7 +34,7 @@ class StreamCollection implements \Countable, \IteratorAggregate
}
/**
* Adds a stream to the collection
* Adds a stream to the collection.
*
* @param Stream $stream
*
@ -48,7 +48,7 @@ class StreamCollection implements \Countable, \IteratorAggregate
}
/**
* Returns a new StreamCollection with only video streams
* Returns a new StreamCollection with only video streams.
*
* @return StreamCollection
*/
@ -60,7 +60,7 @@ class StreamCollection implements \Countable, \IteratorAggregate
}
/**
* Returns a new StreamCollection with only audio streams
* Returns a new StreamCollection with only audio streams.
*
* @return StreamCollection
*/
@ -80,7 +80,7 @@ class StreamCollection implements \Countable, \IteratorAggregate
}
/**
* Returns the array of contained streams
* Returns the array of contained streams.
*
* @return array
*/

View file

@ -14,7 +14,7 @@ namespace FFMpeg\FFProbe;
interface MapperInterface
{
/**
* Maps data given its type
* Maps data given its type.
*
* @param string $type One of FFProbe::TYPE_* constant
* @param string $data The data

View file

@ -14,7 +14,7 @@ namespace FFMpeg\FFProbe;
interface OptionsTesterInterface
{
/**
* Tells if the given option is supported by ffprobe
* Tells if the given option is supported by ffprobe.
*
* @param string $name
*

View file

@ -14,7 +14,7 @@ namespace FFMpeg\FFProbe;
interface OutputParserInterface
{
/**
* Parses ffprobe raw output
* Parses ffprobe raw output.
*
* @param string $type One of FFProbe::TYPE_* constant
* @param string $data The data