examples: update descriptions

Make them not say "this is an example showing..." and instead just say what the example shows. Closes #9960
2022-11-22 10:57:55 +01:00 · 2022-11-22 10:57:55 +01:00 · c1cdc08cbb
commit c1cdc08cbb
parent af22c2a546
34 changed files with 34 additions and 35 deletions
--- a/docs/examples/externalsocket.c
+++ b/docs/examples/externalsocket.c
@ -22,8 +22,7 @@
 *
 ***************************************************************************/
 /* <DESC>
- * An example demonstrating how an application can pass in a custom
- * socket to libcurl to use. This example also handles the connect itself.
+ * Pass in a custom socket for libcurl to use.
 * </DESC>
 */
 #include <stdio.h>
--- a/docs/examples/imap-append.c
+++ b/docs/examples/imap-append.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to send emails
+ * Send email with IMAP
 * </DESC>
 */

--- a/docs/examples/imap-authzid.c
+++ b/docs/examples/imap-authzid.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to retreieve emails from a shared mailed box
+ * Retreieve emails from a shared IMAP mailbox
 * </DESC>
 */

--- a/docs/examples/imap-copy.c
+++ b/docs/examples/imap-copy.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to copy an email from one folder to another
+ * Copy an email from one IMAP folder to another
 * </DESC>
 */

--- a/docs/examples/imap-create.c
+++ b/docs/examples/imap-create.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to create a new folder
+ * Create a new IMAP folder
 * </DESC>
 */

--- a/docs/examples/imap-delete.c
+++ b/docs/examples/imap-delete.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to delete a folder
+ * Delete an IMAP folder
 * </DESC>
 */

--- a/docs/examples/imap-examine.c
+++ b/docs/examples/imap-examine.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to obtain information about a folder
+ * Obtain information about an IMAP folder
 * </DESC>
 */

--- a/docs/examples/imap-fetch.c
+++ b/docs/examples/imap-fetch.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to retreieve emails
+ * Retreieve IMAP emails
 * </DESC>
 */

--- a/docs/examples/imap-list.c
+++ b/docs/examples/imap-list.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example to list the folders within a mailbox
+ * List the folders within an IMAP mailbox
 * </DESC>
 */

--- a/docs/examples/imap-lsub.c
+++ b/docs/examples/imap-lsub.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example to list the subscribed folders
+ * List the subscribed IMAP folders
 * </DESC>
 */

--- a/docs/examples/imap-multi.c
+++ b/docs/examples/imap-multi.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example using the multi interface
+ * Get IMAP email with the multi interface
 * </DESC>
 */

--- a/docs/examples/imap-noop.c
+++ b/docs/examples/imap-noop.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to perform a noop
+ * Perform an IMAP noop
 * </DESC>
 */

--- a/docs/examples/imap-search.c
+++ b/docs/examples/imap-search.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to search for new emails
+ * Search for new IMAP emails
 * </DESC>
 */

--- a/docs/examples/imap-ssl.c
+++ b/docs/examples/imap-ssl.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example using SSL
+ * IMAP with implicit SSL
 * </DESC>
 */

--- a/docs/examples/imap-store.c
+++ b/docs/examples/imap-store.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example showing how to modify the properties of an email
+ * Modify the properties of an email over IMAP
 * </DESC>
 */

--- a/docs/examples/imap-tls.c
+++ b/docs/examples/imap-tls.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * IMAP example using TLS
+ * IMAP using TLS
 * </DESC>
 */

--- a/docs/examples/multithread.c
+++ b/docs/examples/multithread.c
@ -22,7 +22,7 @@
 *
 ***************************************************************************/
 /* <DESC>
- * A multi-threaded example that uses pthreads to fetch several files at once
+ * A multi-threaded program using pthreads to fetch several files at once
 * </DESC>
 */

--- a/docs/examples/pop3-authzid.c
+++ b/docs/examples/pop3-authzid.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example showing how to retrieve emails from a shared mailbox
+ * Retrieve emails from a shared POP3 mailbox
 * </DESC>
 */

--- a/docs/examples/pop3-dele.c
+++ b/docs/examples/pop3-dele.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example showing how to delete emails
+ * Delete POP3 emails
 * </DESC>
 */

--- a/docs/examples/pop3-list.c
+++ b/docs/examples/pop3-list.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example to list the contents of a mailbox
+ * List the contents of a POP3 mailbox
 * </DESC>
 */

--- a/docs/examples/pop3-multi.c
+++ b/docs/examples/pop3-multi.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example using the multi interface
+ * Get POP3 email using the multi interface
 * </DESC>
 */

--- a/docs/examples/pop3-noop.c
+++ b/docs/examples/pop3-noop.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example showing how to perform a noop
+ * Perform a POP3 noop
 * </DESC>
 */

--- a/docs/examples/pop3-retr.c
+++ b/docs/examples/pop3-retr.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example showing how to retrieve emails
+ * Retrieve POP3 email
 * </DESC>
 */

--- a/docs/examples/pop3-ssl.c
+++ b/docs/examples/pop3-ssl.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example using SSL
+ * Get POP3 email using implicit SSL
 * </DESC>
 */

--- a/docs/examples/pop3-stat.c
+++ b/docs/examples/pop3-stat.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example showing how to obtain message statistics
+ * Obtain POP3 message statistics
 * </DESC>
 */

--- a/docs/examples/pop3-tls.c
+++ b/docs/examples/pop3-tls.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example using TLS
+ * POP3 using TLS
 * </DESC>
 */

--- a/docs/examples/pop3-uidl.c
+++ b/docs/examples/pop3-uidl.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * POP3 example to list the contents of a mailbox by unique ID
+ * List the contents of a POP3 mailbox by unique ID
 * </DESC>
 */

--- a/docs/examples/sendrecv.c
+++ b/docs/examples/sendrecv.c
@ -22,7 +22,7 @@
 *
 ***************************************************************************/
 /* <DESC>
- * An example of curl_easy_send() and curl_easy_recv() usage.
+ * Demonstrate curl_easy_send() and curl_easy_recv() usage.
 * </DESC>
 */

--- a/docs/examples/smtp-expn.c
+++ b/docs/examples/smtp-expn.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * SMTP example showing how to expand an email mailing list
+ * Expand an SMTP email mailing list
 * </DESC>
 */

--- a/docs/examples/smtp-mime.c
+++ b/docs/examples/smtp-mime.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * SMTP example showing how to send mime emails
+ * Send SMTP mime emails
 * </DESC>
 */

--- a/docs/examples/smtp-multi.c
+++ b/docs/examples/smtp-multi.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * SMTP example using the multi interface
+ * Send SMTP email with the multi interface
 * </DESC>
 */

--- a/docs/examples/smtp-ssl.c
+++ b/docs/examples/smtp-ssl.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * SMTP example using SSL
+ * Send SMTP email using implicit SSL
 * </DESC>
 */

--- a/docs/examples/smtp-tls.c
+++ b/docs/examples/smtp-tls.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * SMTP example using TLS
+ * Send SMTP email using implicit TLS
 * </DESC>
 */

--- a/docs/examples/smtp-vrfy.c
+++ b/docs/examples/smtp-vrfy.c
@ -23,7 +23,7 @@
 ***************************************************************************/

 /* <DESC>
- * SMTP example showing how to verify an email address
+ * Verify an SMTP email address
 * </DESC>
 */