diff options
author | Diego Biurrun <diego@biurrun.de> | 2014-02-16 22:09:30 +0100 |
---|---|---|
committer | Diego Biurrun <diego@biurrun.de> | 2014-02-17 15:36:17 +0100 |
commit | 2f2b2efd31f6af997812a70de22b6d717fb41d4e (patch) | |
tree | 18e4dae6ed81059c1d395a398ee3d6f31424f1ae | |
parent | 4d7ab5cfebef91820af2933ef2f622ea598e6b53 (diff) | |
download | ffmpeg-2f2b2efd31f6af997812a70de22b6d717fb41d4e.tar.gz |
doxygen: Replace @parblock syntax with manual linebreaks
@parblock is only supported in very recent Doxygen versions.
-rw-r--r-- | libavformat/avformat.h | 18 |
1 files changed, 7 insertions, 11 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h index ec1f9c77b0..ec9c2627cb 100644 --- a/libavformat/avformat.h +++ b/libavformat/avformat.h @@ -1543,24 +1543,22 @@ int avformat_write_header(AVFormatContext *s, AVDictionary **options); * function. * * @param s media file handle - * @param pkt @parblock - * The packet containing the data to be written. Note that unlike + * @param pkt The packet containing the data to be written. Note that unlike * av_interleaved_write_frame(), this function does not take * ownership of the packet passed to it (though some muxers may make * an internal reference to the input packet). - * + * <br> * This parameter can be NULL (at any time, not just at the end), in * order to immediately flush data buffered within the muxer, for * muxers that buffer up data internally before writing it to the * output. - * + * <br> * Packet's @ref AVPacket.stream_index "stream_index" field must be * set to the index of the corresponding stream in @ref * AVFormatContext.streams "s->streams". It is very strongly * recommended that timing information (@ref AVPacket.pts "pts", @ref * AVPacket.dts "dts", @ref AVPacket.duration "duration") is set to * correct values. - * @endparblock * @return < 0 on error, = 0 if OK, 1 if flushed and there is no more data to flush * * @see av_interleaved_write_frame() @@ -1576,26 +1574,24 @@ int av_write_frame(AVFormatContext *s, AVPacket *pkt); * av_write_frame() instead of this function. * * @param s media file handle - * @param pkt @parblock - * The packet containing the data to be written. - * + * @param pkt The packet containing the data to be written. + * <br> * If the packet is reference-counted, this function will take * ownership of this reference and unreference it later when it sees * fit. * The caller must not access the data through this reference after * this function returns. If the packet is not reference-counted, * libavformat will make a copy. - * + * <br> * This parameter can be NULL (at any time, not just at the end), to * flush the interleaving queues. - * + * <br> * Packet's @ref AVPacket.stream_index "stream_index" field must be * set to the index of the corresponding stream in @ref * AVFormatContext.streams "s->streams". It is very strongly * recommended that timing information (@ref AVPacket.pts "pts", @ref * AVPacket.dts "dts", @ref AVPacket.duration "duration") is set to * correct values. - * @endparblock * * @return 0 on success, a negative AVERROR on error. Libavformat will always * take care of freeing the packet, even if this function fails. |