diff mbox series

[FFmpeg-devel,v4,4/4] lavf: Add documentation for private "Context" classes

Message ID 20240429092407.2267590-4-ffmpeg-devel@pileofstuff.org
State New
Headers show
Series [FFmpeg-devel,v4,1/4] doc: Explain what "context" means | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished

Commit Message

Andrew Sayers April 29, 2024, 9:24 a.m. UTC 
Doxygen thinks any text like "Context for foo" is a link to a struct called "Context".
Add a description and a better link, to avoid confusing readers.
---
 libavformat/async.c | 3 +++
 libavformat/cache.c | 3 +++
 2 files changed, 6 insertions(+)
diff mbox series

Patch

diff --git a/libavformat/async.c b/libavformat/async.c
index e096b0bc6f..3c28d418ae 100644
--- a/libavformat/async.c
+++ b/libavformat/async.c
@@ -53,6 +53,9 @@  typedef struct RingBuffer
     int           read_pos;
 } RingBuffer;
 
+/**
+ * @brief @ref md_doc_2context "Context" for testing async
+ */
 typedef struct Context {
     AVClass        *class;
     URLContext     *inner;
diff --git a/libavformat/cache.c b/libavformat/cache.c
index 5f78adba9d..3cc0edec82 100644
--- a/libavformat/cache.c
+++ b/libavformat/cache.c
@@ -52,6 +52,9 @@  typedef struct CacheEntry {
     int size;
 } CacheEntry;
 
+/**
+ * @brief @ref md_doc_2context "Context" for a cache
+ */
 typedef struct Context {
     AVClass *class;
     int fd;