diff options
author | Daniel Stenberg <daniel@haxx.se> | 2015-07-01 11:43:12 +0200 |
---|---|---|
committer | Daniel Stenberg <daniel@haxx.se> | 2015-07-01 11:43:12 +0200 |
commit | c00b18d5406375627b98b47e68261ace85d1a581 (patch) | |
tree | 2a416a2e5faee56ca0bbb231df4331a1b650edd9 /docs | |
parent | 4ed8537be62c8b2689d85f73da4362f4dc537df5 (diff) |
examples: provide <DESC> sections
Diffstat (limited to 'docs')
-rw-r--r-- | docs/examples/htmltitle.cpp | 8 | ||||
-rw-r--r-- | docs/examples/http-post.c | 6 | ||||
-rw-r--r-- | docs/examples/http2-download.c | 4 | ||||
-rw-r--r-- | docs/examples/http2-serverpush.c | 4 | ||||
-rw-r--r-- | docs/examples/http2-upload.c | 4 | ||||
-rw-r--r-- | docs/examples/httpcustomheader.c | 6 | ||||
-rw-r--r-- | docs/examples/httpput.c | 6 | ||||
-rw-r--r-- | docs/examples/https.c | 6 | ||||
-rw-r--r-- | docs/examples/imap-append.c | 6 | ||||
-rw-r--r-- | docs/examples/multi-debugcallback.c | 7 | ||||
-rw-r--r-- | docs/examples/multi-double.c | 6 | ||||
-rw-r--r-- | docs/examples/multi-post.c | 9 | ||||
-rw-r--r-- | docs/examples/multi-single.c | 7 | ||||
-rw-r--r-- | docs/examples/multi-uv.c | 6 | ||||
-rw-r--r-- | docs/examples/multithread.c | 8 | ||||
-rw-r--r-- | docs/examples/opensslthreadlock.c | 13 | ||||
-rw-r--r-- | docs/examples/persistant.c | 6 | ||||
-rw-r--r-- | docs/examples/post-callback.c | 6 |
18 files changed, 89 insertions, 29 deletions
diff --git a/docs/examples/htmltitle.cpp b/docs/examples/htmltitle.cpp index ab89bb6a7..d91b505aa 100644 --- a/docs/examples/htmltitle.cpp +++ b/docs/examples/htmltitle.cpp @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,8 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ -// Get a web page, parse it with libxml. -// +/* <DESC> + * Get a web page, extract the title with libxml. + * </DESC> + */ // Written by Lars Nilsson // // GNU C++ compile command line suggestion (edit paths accordingly): diff --git a/docs/examples/http-post.c b/docs/examples/http-post.c index f1975b1ec..a213c398f 100644 --- a/docs/examples/http-post.c +++ b/docs/examples/http-post.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * simple HTTP POST using the easy interface + * </DESC> + */ #include <stdio.h> #include <curl/curl.h> diff --git a/docs/examples/http2-download.c b/docs/examples/http2-download.c index 3b7ca81d3..8b0650734 100644 --- a/docs/examples/http2-download.c +++ b/docs/examples/http2-download.c @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * Multiplexed HTTP/2 downloads over a single connection + * </DESC> + */ #include <stdio.h> #include <stdlib.h> diff --git a/docs/examples/http2-serverpush.c b/docs/examples/http2-serverpush.c index cc5bf3037..53c491b3a 100644 --- a/docs/examples/http2-serverpush.c +++ b/docs/examples/http2-serverpush.c @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * HTTP/2 server push + * </DESC> + */ #include <stdio.h> #include <stdlib.h> diff --git a/docs/examples/http2-upload.c b/docs/examples/http2-upload.c index bca16c0d6..2ec55059a 100644 --- a/docs/examples/http2-upload.c +++ b/docs/examples/http2-upload.c @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * Multiplexed HTTP/2 uploads over a single connection + * </DESC> + */ #include <stdio.h> #include <stdlib.h> #include <fcntl.h> diff --git a/docs/examples/httpcustomheader.c b/docs/examples/httpcustomheader.c index 8542ead53..e742db969 100644 --- a/docs/examples/httpcustomheader.c +++ b/docs/examples/httpcustomheader.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * HTTP request with custom modified, removed and added headers + * </DESC> + */ #include <stdio.h> #include <curl/curl.h> diff --git a/docs/examples/httpput.c b/docs/examples/httpput.c index 2e9dc2170..71191164f 100644 --- a/docs/examples/httpput.c +++ b/docs/examples/httpput.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2012, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * HTTP PUT with easy interface and read callback + * </DESC> + */ #include <stdio.h> #include <fcntl.h> #include <sys/stat.h> diff --git a/docs/examples/https.c b/docs/examples/https.c index bd9a33ba6..2d5909eaa 100644 --- a/docs/examples/https.c +++ b/docs/examples/https.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2012, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * Simple HTTPS GET + * </DESC> + */ #include <stdio.h> #include <curl/curl.h> diff --git a/docs/examples/imap-append.c b/docs/examples/imap-append.c index fa531a8c5..fb58b4b23 100644 --- a/docs/examples/imap-append.c +++ b/docs/examples/imap-append.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * Simple IMAP APPEND use + * </DESC> + */ #include <stdio.h> #include <string.h> #include <curl/curl.h> diff --git a/docs/examples/multi-debugcallback.c b/docs/examples/multi-debugcallback.c index 5fb86bea1..6769024ac 100644 --- a/docs/examples/multi-debugcallback.c +++ b/docs/examples/multi-debugcallback.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,7 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ -/* This is an example showing the multi interface and the debug callback. */ +/* <DESC> + * multi interface and debug callback + * </DESC> + */ #include <stdio.h> #include <string.h> diff --git a/docs/examples/multi-double.c b/docs/examples/multi-double.c index 0d8d0de4f..d652e7ca8 100644 --- a/docs/examples/multi-double.c +++ b/docs/examples/multi-double.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * multi interface code doing two parallel HTTP transfers + * </DESC> + */ #include <stdio.h> #include <string.h> diff --git a/docs/examples/multi-post.c b/docs/examples/multi-post.c index 5bfdcfd1e..115dc0ceb 100644 --- a/docs/examples/multi-post.c +++ b/docs/examples/multi-post.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,8 +19,11 @@ * KIND, either express or implied. * ***************************************************************************/ -/* This is an example application source code using the multi interface - * to do a multipart formpost without "blocking". */ +/* <DESC> + * using the multi interface to do a multipart formpost without blocking + * </DESC> + */ + #include <stdio.h> #include <string.h> #include <sys/time.h> diff --git a/docs/examples/multi-single.c b/docs/examples/multi-single.c index a43a9f523..85be24f05 100644 --- a/docs/examples/multi-single.c +++ b/docs/examples/multi-single.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,7 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ -/* This is a very simple example using the multi interface. */ +/* <DESC> + * using the multi interface to do a single download + * </DESC> + */ #include <stdio.h> #include <string.h> diff --git a/docs/examples/multi-uv.c b/docs/examples/multi-uv.c index 0c0f8a2b9..3d6e6de72 100644 --- a/docs/examples/multi-uv.c +++ b/docs/examples/multi-uv.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -20,6 +20,10 @@ * ***************************************************************************/ +/* <DESC> + * multi_socket API using libuv + * </DESC> + */ /* Example application code using the multi socket interface to download multiple files at once, but instead of using curl_multi_perform and curl_multi_wait, which uses select(), we use libuv. diff --git a/docs/examples/multithread.c b/docs/examples/multithread.c index 831a07467..23d5d8aad 100644 --- a/docs/examples/multithread.c +++ b/docs/examples/multithread.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,8 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ -/* A multi-threaded example that uses pthreads extensively to fetch - * X remote files at once */ +/* <DESC> + * A multi-threaded example that uses pthreads to fetch several files at once + * </DESC> + */ #include <stdio.h> #include <pthread.h> diff --git a/docs/examples/opensslthreadlock.c b/docs/examples/opensslthreadlock.c index ad54f08ea..03ec1f29b 100644 --- a/docs/examples/opensslthreadlock.c +++ b/docs/examples/opensslthreadlock.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,16 +19,17 @@ * KIND, either express or implied. * ***************************************************************************/ -/* Example source code to show one way to set the necessary OpenSSL locking - * callbacks if you want to do multi-threaded transfers with HTTPS/FTPS with - * libcurl built to use OpenSSL. - * +/* <DESC> + * one way to set the necessary OpenSSL locking callbacks if you want to do + * multi-threaded transfers with HTTPS/FTPS with libcurl built to use OpenSSL. + * </DESC> + */ +/* * This is not a complete stand-alone example. * * Author: Jeremy Brown */ - #include <stdio.h> #include <pthread.h> #include <openssl/err.h> diff --git a/docs/examples/persistant.c b/docs/examples/persistant.c index 0917dfdb8..3e6af18f2 100644 --- a/docs/examples/persistant.c +++ b/docs/examples/persistant.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ +/* <DESC> + * re-using handles to do HTTP persistent connections + * </DESC> + */ #include <stdio.h> #include <unistd.h> #include <curl/curl.h> diff --git a/docs/examples/post-callback.c b/docs/examples/post-callback.c index 3e1cfb060..a2f0427fe 100644 --- a/docs/examples/post-callback.c +++ b/docs/examples/post-callback.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2012, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,8 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ -/* An example source code that issues a HTTP POST and we provide the actual +/* <DESC> + * An example source code that issues a HTTP POST and we provide the actual * data through a read callback. + * </DESC> */ #include <stdio.h> #include <string.h> |