getDuration: add documentation

Clement Champetier · Clement Champetier · commit 1c0fa460557c · 2015-02-04T15:58:53.000+01:00
Indicate that the duration is in seconds.
diff --git a/src/AvTranscoder/file/FormatContext.hpp b/src/AvTranscoder/file/FormatContext.hpp
@@ -58,6 +58,7 @@ class AvExport FormatContext
 	AVStream& addAVStream( const AVCodec& avCodec );
 
 	size_t getNbStreams() const { return _avFormatContext->nb_streams; }
+	/// Get duration of the program, in seconds
 	size_t getDuration() const { return _avFormatContext->duration; }
 	size_t getStartTime() const { return _avFormatContext->start_time; }
 
diff --git a/src/AvTranscoder/stream/InputStream.hpp b/src/AvTranscoder/stream/InputStream.hpp
@@ -22,6 +22,7 @@ class AvExport InputStream : public IInputStream
 	bool readNextPacket( CodedData& data );
 
 	size_t getStreamIndex() const { return _streamIndex; }
+	/// Get duration of the stream, in seconds
 	double getDuration() const;
 	AVMediaType getStreamType() const;
 
diff --git a/src/AvTranscoder/transcoder/StreamTranscoder.hpp b/src/AvTranscoder/transcoder/StreamTranscoder.hpp
@@ -60,7 +60,7 @@ class AvExport StreamTranscoder
 	//@}
 
 	/**
-	 * @brief Get the duration of the stream.
+	 * @brief Get the duration of the stream, in seconds
 	 * @note if it's a generated stream, return limit of double.
 	 */
 	double getDuration() const;
@@ -98,7 +98,7 @@ class AvExport StreamTranscoder
 
 	int  _subStreamIndex;  ///< Index of channel that is processed from the input stream (-1 if no demultiplexing).
 
-	size_t _frameProcessed;  ///< How many frame processed for this StreamTranscoder.
+	size_t _frameProcessed;  ///< How many frames have been processed by the StreamTranscoder.
 	size_t _offset;  ///< Offset, in frame, at the beginning of the StreamTranscoder.
 
 	bool _takeFromGenerator;  ///< Is the data processed are taken from a generator.
diff --git a/src/AvTranscoder/transcoder/Transcoder.hpp b/src/AvTranscoder/transcoder/Transcoder.hpp
@@ -145,18 +145,18 @@ class AvExport Transcoder
 	InputFile* addInputFile( const std::string& filename, const size_t streamIndex );
 
 	/**
-	 * @brief Get the duration of the stream.
+	 * @brief Get the duration of the stream, in seconds
 	 * @note If the stream is a generator, return limit of double.
 	 */
 	double getStreamDuration( size_t indexStream ) const;
 
 	/**
-	* @brief Get the duration of the shortest stream.
+	* @brief Get the duration of the shortest stream, in seconds
 	*/
 	double getMinTotalDuration() const;
 
 	/**
-	 * @brief Get the duration of the longest stream.
+	 * @brief Get the duration of the longest stream, in seconds
 	 */
 	double getMaxTotalDuration() const;
 
