FaSTTUBe/GST-Tensordecoder-ov_ep
37
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: add minimal docblobs for status code and headers

Browse Source 
Use a trick to avoid documenting all 100 enums.
This commit is contained in:
Stefan Kost 2011-05-23 23:51:15 +03:00
parent deeae48a03
commit 8ca5d1274b
2 changed files with 59 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/libs/gst-plugins-base-libs-sections.txt
View File

@ -1392,6 +1392,7 @@ gst_rtp_buffer_list_add_extension_twobytes_header
<FILE>gstrtspdefs</FILE> <FILE>gstrtspdefs</FILE>
<INCLUDE>gst/rtsp/gstrtspdefs.h</INCLUDE> <INCLUDE>gst/rtsp/gstrtspdefs.h</INCLUDE>
GST_RTSP_CHECK GST_RTSP_CHECK
GST_RTSP_AUTH_MAX
GstRTSPEvent GstRTSPEvent
GstRTSPResult GstRTSPResult
GstRTSPFamily GstRTSPFamily
@ -1399,7 +1400,6 @@ GstRTSPState
GstRTSPVersion GstRTSPVersion
GstRTSPMethod GstRTSPMethod
GstRTSPAuthMethod GstRTSPAuthMethod
GST_RTSP_AUTH_MAX
GstRTSPHeaderField GstRTSPHeaderField
GstRTSPStatusCode GstRTSPStatusCode
gst_rtsp_strresult gst_rtsp_strresult

12
gst-libs/gst/rtsp/gstrtspdefs.h
View File

@ -225,7 +225,13 @@ typedef enum {
*/ */
#define GST_RTSP_AUTH_MAX GST_RTSP_AUTH_DIGEST #define GST_RTSP_AUTH_MAX GST_RTSP_AUTH_DIGEST
/**
* GstRTSPHeaderField:
*
* Enumeration of rtsp header fields.
*/
typedef enum { typedef enum {
/*< protected >*/
GST_RTSP_HDR_INVALID, GST_RTSP_HDR_INVALID,
/* /*
@ -330,7 +336,13 @@ typedef enum {
GST_RTSP_HDR_LAST GST_RTSP_HDR_LAST
} GstRTSPHeaderField; } GstRTSPHeaderField;
/**
* GstRTSPStatusCode:
*
* Enumeration of rtsp status codes.
*/
typedef enum { typedef enum {
/*< protected >*/
GST_RTSP_STS_INVALID = 0, GST_RTSP_STS_INVALID = 0,
GST_RTSP_STS_CONTINUE = 100, GST_RTSP_STS_CONTINUE = 100,
GST_RTSP_STS_OK = 200, GST_RTSP_STS_OK = 200,