stream: update doxygen

gregor71 · Apr 13, 2020 · 21fad37 · 21fad37
1 parent a359a51
commit 21fad37
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/include/baresip.h b/include/baresip.h
@@ -1238,9 +1238,9 @@ const struct vidcodec *video_codec(const struct video *vid, bool tx);
 
 /** Common parameters for media stream */
 struct stream_param {
-	bool use_rtp;
-	int af;
-	const char *cname;
+	bool use_rtp;       /**< Enable or disable RTP */
+	int af;             /**< Wanted address family */
+	const char *cname;  /**< Canonical name        */
 };
 
 typedef void (stream_mnatconn_h)(struct stream *strm, void *arg);

diff --git a/src/stream.c b/src/stream.c
@@ -836,6 +836,14 @@ void stream_set_session_handlers(struct stream *strm,
 }
 
 
+/**
+ * Print stream debug info
+ *
+ * @param pf Print function
+ * @param s  Stream object
+ *
+ * @return 0 if success, otherwise errorcode
+ */
 int stream_debug(struct re_printf *pf, const struct stream *s)
 {
 	int err;
@@ -1068,6 +1076,13 @@ int stream_start(const struct stream *strm)
 }
 
 
+/**
+ * Get the name of the stream type (e.g. audio or video)
+ *
+ * @param strm Stream object
+ *
+ * @return Name of stream type
+ */
 const char *stream_name(const struct stream *strm)
 {
 	if (!strm)