From: Daniel Stenberg Date: Tue, 22 Nov 2022 09:57:55 +0000 (+0100) Subject: examples: update descriptions X-Git-Tag: curl-7_87_0~123 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c1cdc08cbba4baa5297789a51e320537d787df22;p=thirdparty%2Fcurl.git examples: update descriptions Make them not say "this is an example showing..." and instead just say what the example shows. Closes #9960 --- diff --git a/docs/examples/externalsocket.c b/docs/examples/externalsocket.c index dfdd1c2759..f0deeb9ed1 100644 --- a/docs/examples/externalsocket.c +++ b/docs/examples/externalsocket.c @@ -22,8 +22,7 @@ * ***************************************************************************/ /* - * 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. * */ #include diff --git a/docs/examples/imap-append.c b/docs/examples/imap-append.c index b66d8687ed..303c36fa94 100644 --- a/docs/examples/imap-append.c +++ b/docs/examples/imap-append.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to send emails + * Send email with IMAP * */ diff --git a/docs/examples/imap-authzid.c b/docs/examples/imap-authzid.c index 62eca4a685..0ec065db29 100644 --- a/docs/examples/imap-authzid.c +++ b/docs/examples/imap-authzid.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to retreieve emails from a shared mailed box + * Retreieve emails from a shared IMAP mailbox * */ diff --git a/docs/examples/imap-copy.c b/docs/examples/imap-copy.c index 81ec5be709..10e3e74e94 100644 --- a/docs/examples/imap-copy.c +++ b/docs/examples/imap-copy.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to copy an email from one folder to another + * Copy an email from one IMAP folder to another * */ diff --git a/docs/examples/imap-create.c b/docs/examples/imap-create.c index 12e7113f3f..b73c6d1af8 100644 --- a/docs/examples/imap-create.c +++ b/docs/examples/imap-create.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to create a new folder + * Create a new IMAP folder * */ diff --git a/docs/examples/imap-delete.c b/docs/examples/imap-delete.c index 467b06010d..693f6b9743 100644 --- a/docs/examples/imap-delete.c +++ b/docs/examples/imap-delete.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to delete a folder + * Delete an IMAP folder * */ diff --git a/docs/examples/imap-examine.c b/docs/examples/imap-examine.c index 68cc636937..782dc0fca3 100644 --- a/docs/examples/imap-examine.c +++ b/docs/examples/imap-examine.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to obtain information about a folder + * Obtain information about an IMAP folder * */ diff --git a/docs/examples/imap-fetch.c b/docs/examples/imap-fetch.c index d6237c3860..9c73e50754 100644 --- a/docs/examples/imap-fetch.c +++ b/docs/examples/imap-fetch.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to retreieve emails + * Retreieve IMAP emails * */ diff --git a/docs/examples/imap-list.c b/docs/examples/imap-list.c index 85bddac07e..d9c01cd001 100644 --- a/docs/examples/imap-list.c +++ b/docs/examples/imap-list.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example to list the folders within a mailbox + * List the folders within an IMAP mailbox * */ diff --git a/docs/examples/imap-lsub.c b/docs/examples/imap-lsub.c index 1b22fa1e2d..18de272380 100644 --- a/docs/examples/imap-lsub.c +++ b/docs/examples/imap-lsub.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example to list the subscribed folders + * List the subscribed IMAP folders * */ diff --git a/docs/examples/imap-multi.c b/docs/examples/imap-multi.c index 3b5c633683..ace2551d95 100644 --- a/docs/examples/imap-multi.c +++ b/docs/examples/imap-multi.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example using the multi interface + * Get IMAP email with the multi interface * */ diff --git a/docs/examples/imap-noop.c b/docs/examples/imap-noop.c index ee1a7772d9..3c7497d60b 100644 --- a/docs/examples/imap-noop.c +++ b/docs/examples/imap-noop.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to perform a noop + * Perform an IMAP noop * */ diff --git a/docs/examples/imap-search.c b/docs/examples/imap-search.c index 7b175b27cf..b92547474e 100644 --- a/docs/examples/imap-search.c +++ b/docs/examples/imap-search.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to search for new emails + * Search for new IMAP emails * */ diff --git a/docs/examples/imap-ssl.c b/docs/examples/imap-ssl.c index 5b0befbc21..bf36e31e2c 100644 --- a/docs/examples/imap-ssl.c +++ b/docs/examples/imap-ssl.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example using SSL + * IMAP with implicit SSL * */ diff --git a/docs/examples/imap-store.c b/docs/examples/imap-store.c index 6a4c756778..571b218d9f 100644 --- a/docs/examples/imap-store.c +++ b/docs/examples/imap-store.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example showing how to modify the properties of an email + * Modify the properties of an email over IMAP * */ diff --git a/docs/examples/imap-tls.c b/docs/examples/imap-tls.c index dbebbc7227..124c042409 100644 --- a/docs/examples/imap-tls.c +++ b/docs/examples/imap-tls.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * IMAP example using TLS + * IMAP using TLS * */ diff --git a/docs/examples/multithread.c b/docs/examples/multithread.c index 4f2c85574b..2b89798e39 100644 --- a/docs/examples/multithread.c +++ b/docs/examples/multithread.c @@ -22,7 +22,7 @@ * ***************************************************************************/ /* - * 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 * */ diff --git a/docs/examples/pop3-authzid.c b/docs/examples/pop3-authzid.c index 8e0c2f2c6e..168eb76fc2 100644 --- a/docs/examples/pop3-authzid.c +++ b/docs/examples/pop3-authzid.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example showing how to retrieve emails from a shared mailbox + * Retrieve emails from a shared POP3 mailbox * */ diff --git a/docs/examples/pop3-dele.c b/docs/examples/pop3-dele.c index d0281cb764..7aea644e08 100644 --- a/docs/examples/pop3-dele.c +++ b/docs/examples/pop3-dele.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example showing how to delete emails + * Delete POP3 emails * */ diff --git a/docs/examples/pop3-list.c b/docs/examples/pop3-list.c index 991ff24172..1dae86ea54 100644 --- a/docs/examples/pop3-list.c +++ b/docs/examples/pop3-list.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example to list the contents of a mailbox + * List the contents of a POP3 mailbox * */ diff --git a/docs/examples/pop3-multi.c b/docs/examples/pop3-multi.c index 69a1088579..53d0fd5111 100644 --- a/docs/examples/pop3-multi.c +++ b/docs/examples/pop3-multi.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example using the multi interface + * Get POP3 email using the multi interface * */ diff --git a/docs/examples/pop3-noop.c b/docs/examples/pop3-noop.c index a3ecb8821e..41c205df53 100644 --- a/docs/examples/pop3-noop.c +++ b/docs/examples/pop3-noop.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example showing how to perform a noop + * Perform a POP3 noop * */ diff --git a/docs/examples/pop3-retr.c b/docs/examples/pop3-retr.c index 1df0657163..d3866f3aa4 100644 --- a/docs/examples/pop3-retr.c +++ b/docs/examples/pop3-retr.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example showing how to retrieve emails + * Retrieve POP3 email * */ diff --git a/docs/examples/pop3-ssl.c b/docs/examples/pop3-ssl.c index 6f3455a699..0415363d7d 100644 --- a/docs/examples/pop3-ssl.c +++ b/docs/examples/pop3-ssl.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example using SSL + * Get POP3 email using implicit SSL * */ diff --git a/docs/examples/pop3-stat.c b/docs/examples/pop3-stat.c index 3df35719d6..f78ea5f395 100644 --- a/docs/examples/pop3-stat.c +++ b/docs/examples/pop3-stat.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example showing how to obtain message statistics + * Obtain POP3 message statistics * */ diff --git a/docs/examples/pop3-tls.c b/docs/examples/pop3-tls.c index d58b5e49a8..3e8d8db3b5 100644 --- a/docs/examples/pop3-tls.c +++ b/docs/examples/pop3-tls.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example using TLS + * POP3 using TLS * */ diff --git a/docs/examples/pop3-uidl.c b/docs/examples/pop3-uidl.c index 308de3b441..6fa9b210de 100644 --- a/docs/examples/pop3-uidl.c +++ b/docs/examples/pop3-uidl.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * POP3 example to list the contents of a mailbox by unique ID + * List the contents of a POP3 mailbox by unique ID * */ diff --git a/docs/examples/sendrecv.c b/docs/examples/sendrecv.c index 7da740a095..954ae810ba 100644 --- a/docs/examples/sendrecv.c +++ b/docs/examples/sendrecv.c @@ -22,7 +22,7 @@ * ***************************************************************************/ /* - * An example of curl_easy_send() and curl_easy_recv() usage. + * Demonstrate curl_easy_send() and curl_easy_recv() usage. * */ diff --git a/docs/examples/smtp-expn.c b/docs/examples/smtp-expn.c index 6d9d4a4b83..dc2351af1c 100644 --- a/docs/examples/smtp-expn.c +++ b/docs/examples/smtp-expn.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * SMTP example showing how to expand an email mailing list + * Expand an SMTP email mailing list * */ diff --git a/docs/examples/smtp-mime.c b/docs/examples/smtp-mime.c index ce95582b31..76a91eb4bd 100644 --- a/docs/examples/smtp-mime.c +++ b/docs/examples/smtp-mime.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * SMTP example showing how to send mime emails + * Send SMTP mime emails * */ diff --git a/docs/examples/smtp-multi.c b/docs/examples/smtp-multi.c index 385827c0c8..80b156bd0f 100644 --- a/docs/examples/smtp-multi.c +++ b/docs/examples/smtp-multi.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * SMTP example using the multi interface + * Send SMTP email with the multi interface * */ diff --git a/docs/examples/smtp-ssl.c b/docs/examples/smtp-ssl.c index 70b2045917..4ccf7686d5 100644 --- a/docs/examples/smtp-ssl.c +++ b/docs/examples/smtp-ssl.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * SMTP example using SSL + * Send SMTP email using implicit SSL * */ diff --git a/docs/examples/smtp-tls.c b/docs/examples/smtp-tls.c index e30f4788e2..c33c902def 100644 --- a/docs/examples/smtp-tls.c +++ b/docs/examples/smtp-tls.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * SMTP example using TLS + * Send SMTP email using implicit TLS * */ diff --git a/docs/examples/smtp-vrfy.c b/docs/examples/smtp-vrfy.c index e6815b6cb1..d88bfc7d87 100644 --- a/docs/examples/smtp-vrfy.c +++ b/docs/examples/smtp-vrfy.c @@ -23,7 +23,7 @@ ***************************************************************************/ /* - * SMTP example showing how to verify an email address + * Verify an SMTP email address * */