summaryrefslogtreecommitdiff
path: root/ext/curl/gstcurlsftpsink.c
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/gstcurlsftpsink.c
parent90f766cc518b4fde651162d6e0c7d190373e3c61 (diff)
downloadgstreamer-plugins-bad-78022a6e0c05ce482b798cf638cbd3f901a5094e.tar.gz
docs: Port all docstring to gtk-doc markdown
Diffstat (limited to 'ext/curl/gstcurlsftpsink.c')
-rw-r--r--ext/curl/gstcurlsftpsink.c9
1 files changed, 5 insertions, 4 deletions
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