summaryrefslogtreecommitdiff
path: root/ext/curl
diff options
context:
space:
mode:
authorThibault Saunier <thibault.saunier@osg.samsung.com>2017-03-08 15:01:13 -0300
committerThibault Saunier <thibault.saunier@osg.samsung.com>2017-04-12 12:57:57 -0300
commit78022a6e0c05ce482b798cf638cbd3f901a5094e (patch)
tree9725b5939d840f6eb3e8f39e032866e82413cb83 /ext/curl
parent90f766cc518b4fde651162d6e0c7d190373e3c61 (diff)
downloadgstreamer-plugins-bad-78022a6e0c05ce482b798cf638cbd3f901a5094e.tar.gz
docs: Port all docstring to gtk-doc markdown
Diffstat (limited to 'ext/curl')
-rw-r--r--ext/curl/gstcurlbasesink.c6
-rw-r--r--ext/curl/gstcurlfilesink.c7
-rw-r--r--ext/curl/gstcurlftpsink.c10
-rw-r--r--ext/curl/gstcurlhttpsink.c8
-rw-r--r--ext/curl/gstcurlsftpsink.c9
-rw-r--r--ext/curl/gstcurlsmtpsink.c9
-rw-r--r--ext/curl/gstcurlsshsink.c1
-rw-r--r--ext/curl/gstcurltlssink.c1
8 files changed, 30 insertions, 21 deletions
diff --git a/ext/curl/gstcurlbasesink.c b/ext/curl/gstcurlbasesink.c
index 40c61826d..375c46aef 100644
--- a/ext/curl/gstcurlbasesink.c
+++ b/ext/curl/gstcurlbasesink.c
@@ -19,14 +19,14 @@
/**
* SECTION:element-curlsink
+ * @title: curlsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* a server (e.g. a HTTP/FTP server).
*
- * <refsect2>
- * <title>Example launch line (upload a JPEG file to an HTTP server)</title>
+ * ## Example launch line (upload a JPEG file to an HTTP server)
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlsink \
* file-name=image.jpg \
@@ -35,7 +35,7 @@
* content-type=image/jpeg \
* use-content-length=false
* ]|
- * </refsect2>
+ *
*/
#ifdef HAVE_CONFIG_H
diff --git a/ext/curl/gstcurlfilesink.c b/ext/curl/gstcurlfilesink.c
index b4aa1747b..519c135ac 100644
--- a/ext/curl/gstcurlfilesink.c
+++ b/ext/curl/gstcurlfilesink.c
@@ -19,21 +19,20 @@
/**
* SECTION:element-curlfilesink
+ * @title: curlfilesink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* a local or network drive.
*
- * <refsect2>
- * <title>Example launch line (upload a JPEG file to /home/test/images
- * directory)</title>
+ * ## Example launch line (upload a JPEG file to /home/test/images directory)
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlfilesink \
* file-name=image.jpg \
* location=file:///home/test/images/
* ]|
- * </refsect2>
+ *
*/
#ifdef HAVE_CONFIG_H
diff --git a/ext/curl/gstcurlftpsink.c b/ext/curl/gstcurlftpsink.c
index 92b5c4e08..55b6f6a9a 100644
--- a/ext/curl/gstcurlftpsink.c
+++ b/ext/curl/gstcurlftpsink.c
@@ -19,21 +19,23 @@
/**
* SECTION:element-curlftpsink
+ * @title: curlftpsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* an FTP server.
*
- * <refsect2>
- * <title>Example launch line (upload a JPEG file to /home/test/images
- * directory)</title>
+ * ## Example launch line
+ *
+ * Upload a JPEG file to /home/test/images * directory)
+ *
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlftpsink \
* file-name=image.jpg \
* location=ftp://192.168.0.1/images/
* ]|
- * </refsect2>
+ *
*/
#ifdef HAVE_CONFIG_H
diff --git a/ext/curl/gstcurlhttpsink.c b/ext/curl/gstcurlhttpsink.c
index a50a057e4..3df255574 100644
--- a/ext/curl/gstcurlhttpsink.c
+++ b/ext/curl/gstcurlhttpsink.c
@@ -19,14 +19,17 @@
/**
* SECTION:element-curlhttpsink
+ * @title: curlhttpsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* an HTTP server.
*
- * <refsect2>
- * <title>Example launch line (upload a JPEG file to an HTTP server)</title>
+ * ## Example launch line
+ *
+ * Upload a JPEG file to an HTTP server.
+ *
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlhttpsink \
* file-name=image.jpg \
@@ -35,7 +38,6 @@
* content-type=image/jpeg \
* use-content-length=false
* ]|
- * </refsect2>
*/
#ifdef HAVE_CONFIG_H
diff --git a/ext/curl/gstcurlsftpsink.c b/ext/curl/gstcurlsftpsink.c
index 939ebd8b9..c3549c81f 100644
--- a/ext/curl/gstcurlsftpsink.c
+++ b/ext/curl/gstcurlsftpsink.c
@@ -19,14 +19,17 @@
/**
* SECTION:element-curlsftpsink
+ * @title: curlsftpsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* a SFTP (SSH File Transfer Protocol) server.
*
- * <refsect2>
- * <title>Example launch line (upload a file to /home/john/sftp_tests/)</title>
+ * ## Example launch line
+ *
+ * Upload a file to /home/john/sftp_tests/
+ *
* |[
* gst-launch-1.0 filesrc location=/home/jdoe/some.file ! curlsftpsink \
* file-name=some.file.backup \
@@ -36,8 +39,6 @@
* ssh-priv-keyfile=/home/jdoe/.ssh/id_rsa \
* create-dirs=TRUE
* ]|
- * </refsect2>
- *
*/
#ifdef HAVE_CONFIG_H
diff --git a/ext/curl/gstcurlsmtpsink.c b/ext/curl/gstcurlsmtpsink.c
index 07a147430..b9e9bf2d9 100644
--- a/ext/curl/gstcurlsmtpsink.c
+++ b/ext/curl/gstcurlsmtpsink.c
@@ -19,14 +19,17 @@
/**
* SECTION:element-curlsink
+ * @title: curlsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
* This is a network sink that uses libcurl as a client to upload data to
* an SMTP server.
*
- * <refsect2>
- * <title>Example launch line (upload a JPEG file to an SMTP server)</title>
+ * ## Example launch line
+ *
+ * Upload a JPEG file to an SMTP server.
+ *
* |[
* gst-launch-1.0 filesrc location=image.jpg ! jpegparse ! curlsmtpsink \
* file-name=image.jpg \
@@ -38,7 +41,7 @@
* use-ssl=TRUE \
* insecure=TRUE
* ]|
- * </refsect2>
+ *
*/
#ifdef HAVE_CONFIG_H
diff --git a/ext/curl/gstcurlsshsink.c b/ext/curl/gstcurlsshsink.c
index b06cbcd5b..cdbff086b 100644
--- a/ext/curl/gstcurlsshsink.c
+++ b/ext/curl/gstcurlsshsink.c
@@ -19,6 +19,7 @@
/**
* SECTION:element-curlsshsink
+ * @title: curlsshsink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*
diff --git a/ext/curl/gstcurltlssink.c b/ext/curl/gstcurltlssink.c
index 35c1c1c5a..94f9d6544 100644
--- a/ext/curl/gstcurltlssink.c
+++ b/ext/curl/gstcurltlssink.c
@@ -19,6 +19,7 @@
/**
* SECTION:element-curltlssink
+ * @title: curltlssink
* @short_description: sink that uploads data to a server using libcurl
* @see_also:
*