Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
 help / color / mirror / Atom feed
From: Marvin Scholz <epirat07@gmail.com>
To: ffmpeg-devel@ffmpeg.org
Cc: Marvin Scholz <epirat07@gmail.com>
Subject: [FFmpeg-devel] [PATCH v3 51/54] avcodec/bsf: document missing arguments
Date: Sun, 25 Sep 2022 02:11:18 +0200
Message-ID: <20220925001121.37721-52-epirat07@gmail.com> (raw)
In-Reply-To: <20220925001121.37721-1-epirat07@gmail.com>

---
 libavcodec/bsf.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/libavcodec/bsf.h b/libavcodec/bsf.h
index 69d91a16ab..17fa6141ee 100644
--- a/libavcodec/bsf.h
+++ b/libavcodec/bsf.h
@@ -164,6 +164,8 @@ int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
 /**
  * Prepare the filter for use, after all the parameters and options have been
  * set.
+ * 
+ * @param ctx a AVBSFContext previously allocated with av_bsf_alloc()
  */
 int av_bsf_init(AVBSFContext *ctx);
 
@@ -174,6 +176,7 @@ int av_bsf_init(AVBSFContext *ctx);
  * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
  * AVERROR_EOF.
  *
+ * @param ctx an initialized AVBSFContext
  * @param pkt the packet to filter. The bitstream filter will take ownership of
  * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
  * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
@@ -192,6 +195,7 @@ int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
 /**
  * Retrieve a filtered packet.
  *
+ * @param ctx an initialized AVBSFContext
  * @param[out] pkt this struct will be filled with the contents of the filtered
  *                 packet. It is owned by the caller and must be freed using
  *                 av_packet_unref() when it is no longer needed.
-- 
2.37.0 (Apple Git-136)

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

  parent reply	other threads:[~2022-09-25  0:19 UTC|newest]

Thread overview: 69+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-22  2:03 [FFmpeg-devel] [PATCH v2 1/7] avcodec: Fix Doxygen trailing brief comments Marvin Scholz
2022-09-22  2:03 ` [FFmpeg-devel] [PATCH v2 2/7] avdevice/avdevice: Fix mismatching argument name Marvin Scholz
2022-09-23  7:32   ` Michael Niedermayer
2022-09-22  2:03 ` [FFmpeg-devel] [PATCH v2 3/7] avformat/avformat: Fix mismatching argument names Marvin Scholz
2022-09-23  7:30   ` Michael Niedermayer
2022-09-22  2:03 ` [FFmpeg-devel] [PATCH v2 4/7] avutil: " Marvin Scholz
2022-09-23  7:28   ` Michael Niedermayer
2022-09-22  2:03 ` [FFmpeg-devel] [PATCH v2 5/7] swresample/swresample: " Marvin Scholz
2022-09-23  7:27   ` Michael Niedermayer
2022-09-22  2:03 ` [FFmpeg-devel] [PATCH v2 6/7] avformat/avformat: Improve doxy style Marvin Scholz
2022-09-22  2:04 ` [FFmpeg-devel] [PATCH v2 7/7] avcodec/avcodec: Escape Doxygen reference Marvin Scholz
2022-09-23  7:32 ` [FFmpeg-devel] [PATCH v2 1/7] avcodec: Fix Doxygen trailing brief comments Michael Niedermayer
2022-09-25  0:10 ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 01/54] avcodec: Fix Doxygen trailing brief comments Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 02/54] avdevice/avdevice: Fix mismatching argument name Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 03/54] avformat/avformat: Fix mismatching argument names Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 04/54] avutil: " Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 05/54] swresample/swresample: " Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 06/54] avformat/avformat: Improve doxy style Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 07/54] avcodec/avcodec: Escape Doxygen reference Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 08/54] avutil/channel_layout: Remove bogus closing group Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 09/54] avutil/channel_layout: Move to its own group Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 10/54] avutil/channel_layout: Group deprecated functions Marvin Scholz
2022-10-16 13:11     ` Anton Khirnov
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 11/54] avutil/channel_layout: Group pre-defined channel layouts Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 12/54] avutil/twofish: Fix doxy @param typo Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 13/54] avcodec/vdpau: Fix doxy comment typo Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 14/54] avcodec/codec_par: Add missing doxy group opening Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 15/54] avcodec/videotoolbox: Add proper doxy group Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 16/54] avutil/aes_ctr: " Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 17/54] avutil/display: consolidate group doxy Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 18/54] avutil/display: Add file to doxy group Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 19/54] avutil/spherical: consolidate group doxy Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 20/54] avutil/spherical: Add file to doxy group Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 21/54] avutil/stereo3d: consolidate group doxy Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 22/54] avutil/stereo3d: Add file to doxy group Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 23/54] avutil/csp: Fix bogus doxy filename Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 24/54] swscale: Fix bogus doxy comment #ifdefs Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 25/54] avcodec/mediacodec: use inline code for coderefs Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 26/54] avcodec/mediacodec: link to related documentation Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 27/54] doc/Doxyfile: Add FF_PAD_STRUCTURE to PREDEFINED Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 28/54] avutil/bprint: Improve doxy documentation Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 29/54] swresample: Fix Doxy reference to AVOptions Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 30/54] avutil/camellia: Fix doxy @param typo Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 31/54] avutil/channel_layout: Use inline code for Doxy Marvin Scholz
2022-09-25  0:10   ` [FFmpeg-devel] [PATCH v3 32/54] avutil/channel_layout: Document missing arguments Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 33/54] avfilter: Fix doxy references Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 34/54] avformat/avio: Add doxy for missing argument Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 35/54] avutil/detection_bbox: " Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 36/54] avutil/eval: Add doxy for missing arguments Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 37/54] avutil/file: " Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 38/54] avutil/lfg: Add doxy for missing argument Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 39/54] avutil/lfg: Minor doxy improvements Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 40/54] avutil/hwcontext: Add doxy for missing argument Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 41/54] avutil/parseutils: Add doxy for missing arguments Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 42/54] avutil/parseutils: Use inline code and properly escape Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 43/54] avutil/uuid: Remove bogus doxy return doc Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 44/54] avutil/rc4: Add doxy for missing arguments Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 45/54] avutil/frame: Add doxy for missing argument Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 46/54] avutil/avstring: " Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 47/54] avutil/des: Add doxy for missing arguments Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 48/54] avutil/crc: " Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 49/54] avutil/imgutils: document some " Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 50/54] swscale: " Marvin Scholz
2022-09-25  0:11   ` Marvin Scholz [this message]
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 52/54] avutil/aes: " Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 53/54] avutil/aes_ctr: " Marvin Scholz
2022-09-25  0:11   ` [FFmpeg-devel] [PATCH v3 54/54] avutil/samplefmt: document missing argument Marvin Scholz
2022-10-17  8:48   ` [FFmpeg-devel] [PATCH v3 00/54] Various Doxygen fixes Anton Khirnov

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220925001121.37721-52-epirat07@gmail.com \
    --to=epirat07@gmail.com \
    --cc=ffmpeg-devel@ffmpeg.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
		ffmpegdev@gitmailbox.com
	public-inbox-index ffmpegdev

Example config snippet for mirrors.


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git