From 26583a62ab8f29f672f91932b81c595f33c72b9f Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Thu, 18 Jun 2015 10:17:02 +0200 Subject: examples: add descriptions with Using this fixed format for example descriptions, we can generate a better list on the web site. --- docs/examples/10-at-a-time.c | 9 +++++---- docs/examples/anyauthput.c | 7 ++++++- docs/examples/asiohiper.cpp | 10 +++++----- docs/examples/cacertinmem.c | 14 ++++---------- docs/examples/certinfo.c | 6 +++++- docs/examples/chkspeed.c | 6 +++++- docs/examples/cookie_interface.c | 7 +++++-- docs/examples/debug.c | 6 +++++- 8 files changed, 40 insertions(+), 25 deletions(-) (limited to 'docs') diff --git a/docs/examples/10-at-a-time.c b/docs/examples/10-at-a-time.c index 5d95a8a89..f43dc75e0 100644 --- a/docs/examples/10-at-a-time.c +++ b/docs/examples/10-at-a-time.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , 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,9 +19,10 @@ * KIND, either express or implied. * ***************************************************************************/ -/* Example application source code using the multi interface to download many - * files, but with a capped maximum amount of simultaneous transfers. - * +/* + * Source code using the multi interface to download many + * files, with a capped maximum amount of simultaneous transfers. + * * Written by Michael Wallner */ diff --git a/docs/examples/anyauthput.c b/docs/examples/anyauthput.c index b89dca2e1..2962645b9 100644 --- a/docs/examples/anyauthput.c +++ b/docs/examples/anyauthput.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2012, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , 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,11 @@ * KIND, either express or implied. * ***************************************************************************/ +/* + * HTTP PUT upload with authentiction using "any" method. libcurl picks the + * one the server supports/wants. + * + */ #include #include #ifdef WIN32 diff --git a/docs/examples/asiohiper.cpp b/docs/examples/asiohiper.cpp index eb5cd0386..ff4134856 100644 --- a/docs/examples/asiohiper.cpp +++ b/docs/examples/asiohiper.cpp @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 2012 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 2012 - 2015, Daniel Stenberg, , 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,11 +20,11 @@ * ***************************************************************************/ +/* + * demonstrate the use of multi socket interface with boost::asio + * + */ /* - * file: asiohiper.cpp - * Example program to demonstrate the use of multi socket interface - * with boost::asio - * * This program is in c++ and uses boost::asio instead of libevent/libev. * Requires boost::asio, boost::bind and boost::system * diff --git a/docs/examples/cacertinmem.c b/docs/examples/cacertinmem.c index 30a5153a8..67fd382b1 100644 --- a/docs/examples/cacertinmem.c +++ b/docs/examples/cacertinmem.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , 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,17 +19,11 @@ * KIND, either express or implied. * ***************************************************************************/ -/* Example using a "in core" PEM certificate to retrieve a https page. - * Written by Theo Borm +/* + * CA cert in memory with OpenSSL to get a HTTPS page. + * */ -/* on a netBSD system with OPENSSL& LIBCURL installed from - * pkgsrc (using default paths) this program can be compiled using: - * gcc -I/usr/pkg/include -L/usr/pkg/lib -lcurl -Wl,-R/usr/pkg/lib -lssl - * -lcrypto -lz -o curlcacerttest curlcacerttest.c - * on other operating systems you may want to change paths to headers - * and libraries -*/ #include #include #include diff --git a/docs/examples/certinfo.c b/docs/examples/certinfo.c index ac0109b07..7ec70ee1c 100644 --- a/docs/examples/certinfo.c +++ b/docs/examples/certinfo.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , 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. * ***************************************************************************/ +/* + * Extract lots of TLS certificate info. + * + */ #include #include diff --git a/docs/examples/chkspeed.c b/docs/examples/chkspeed.c index 31949b892..bae8ea6b8 100644 --- a/docs/examples/chkspeed.c +++ b/docs/examples/chkspeed.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2011, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , 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. * ***************************************************************************/ +/* + * Show transfer timing info after download completes. + * + */ /* Example source code to show how the callback function can be used to * download data into a chunk of memory instead of storing it in a file. * After successful download we use curl_easy_getinfo() calls to get the diff --git a/docs/examples/cookie_interface.c b/docs/examples/cookie_interface.c index 28ee7817c..b67051c79 100644 --- a/docs/examples/cookie_interface.c +++ b/docs/examples/cookie_interface.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2012, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , 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 example shows usage of simple cookie interface. */ +/* + * Import and export cookies with COOKIELIST. + * + */ #include #include diff --git a/docs/examples/debug.c b/docs/examples/debug.c index 36dd80d70..6baab4405 100644 --- a/docs/examples/debug.c +++ b/docs/examples/debug.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2013, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , 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. * ***************************************************************************/ +/* + * Show how CURLOPT_DEBUGFUNCTION can be used. + * + */ #include #include -- cgit v1.2.3