diff options
author | Diego Biurrun <diego@biurrun.de> | 2014-02-17 02:36:31 +0400 |
---|---|---|
committer | Diego Biurrun <diego@biurrun.de> | 2014-02-17 18:36:09 +0400 |
commit | 4d7ab5cfebef91820af2933ef2f622ea598e6b53 (patch) | |
tree | 2f4625d8352d512b539cef9d68ac8c6b49ba0f6e /libavformat/avio.h | |
parent | 614b9e4db8f3d7c23fc0410fc04745a727a82f4e (diff) |
doxygen: Add a number of missing function parameter descriptions
Diffstat (limited to 'libavformat/avio.h')
-rw-r--r-- | libavformat/avio.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/libavformat/avio.h b/libavformat/avio.h index b6d3cb33b2..3360e8296e 100644 --- a/libavformat/avio.h +++ b/libavformat/avio.h @@ -318,6 +318,7 @@ int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen); * * @param s Used to return the pointer to the created AVIOContext. * In case of failure the pointed to value is set to NULL. + * @param url resource to access * @param flags flags which control how the resource indicated by url * is to be opened * @return 0 in case of success, a negative value corresponding to an @@ -333,6 +334,7 @@ int avio_open(AVIOContext **s, const char *url, int flags); * * @param s Used to return the pointer to the created AVIOContext. * In case of failure the pointed to value is set to NULL. + * @param url resource to access * @param flags flags which control how the resource indicated by url * is to be opened * @param int_cb an interrupt callback to be used at the protocols level @@ -406,6 +408,8 @@ const char *avio_enum_protocols(void **opaque, int output); /** * Pause and resume playing - only meaningful if using a network streaming * protocol (e.g. MMS). + * + * @param h IO context from which to call the read_pause function pointer * @param pause 1 for pause, 0 for resume */ int avio_pause(AVIOContext *h, int pause); @@ -413,6 +417,8 @@ int avio_pause(AVIOContext *h, int pause); /** * Seek to a given timestamp relative to some component stream. * Only meaningful if using a network streaming protocol (e.g. MMS.). + * + * @param h IO context from which to call the seek function pointers * @param stream_index The stream index that the timestamp is relative to. * If stream_index is (-1) the timestamp should be in AV_TIME_BASE * units from the beginning of the presentation. |