]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
examples: update descriptions
authorDaniel Stenberg <daniel@haxx.se>
Tue, 22 Nov 2022 09:57:55 +0000 (10:57 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Tue, 22 Nov 2022 13:41:15 +0000 (14:41 +0100)
Make them not say "this is an example showing..." and instead just say
what the example shows.

Closes #9960

34 files changed:
docs/examples/externalsocket.c
docs/examples/imap-append.c
docs/examples/imap-authzid.c
docs/examples/imap-copy.c
docs/examples/imap-create.c
docs/examples/imap-delete.c
docs/examples/imap-examine.c
docs/examples/imap-fetch.c
docs/examples/imap-list.c
docs/examples/imap-lsub.c
docs/examples/imap-multi.c
docs/examples/imap-noop.c
docs/examples/imap-search.c
docs/examples/imap-ssl.c
docs/examples/imap-store.c
docs/examples/imap-tls.c
docs/examples/multithread.c
docs/examples/pop3-authzid.c
docs/examples/pop3-dele.c
docs/examples/pop3-list.c
docs/examples/pop3-multi.c
docs/examples/pop3-noop.c
docs/examples/pop3-retr.c
docs/examples/pop3-ssl.c
docs/examples/pop3-stat.c
docs/examples/pop3-tls.c
docs/examples/pop3-uidl.c
docs/examples/sendrecv.c
docs/examples/smtp-expn.c
docs/examples/smtp-mime.c
docs/examples/smtp-multi.c
docs/examples/smtp-ssl.c
docs/examples/smtp-tls.c
docs/examples/smtp-vrfy.c

index dfdd1c27593115d6a0772c3b2bac2cdb24450cfc..f0deeb9ed152a060f8c9f3615dc08d1716966b1e 100644 (file)
@@ -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>
index b66d8687edf3ec69bdc499dc7051984ee8e690aa..303c36fa94b38411cd2985f8ac36952659f22073 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example showing how to send emails
+ * Send email with IMAP
  * </DESC>
  */
 
index 62eca4a6850d6997d62bd8f97b083b69c7ccf38c..0ec065db296585d2513d7ef878a898507610f565 100644 (file)
@@ -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>
  */
 
index 81ec5be7096bfe42cd3e216eef7b54ca31129d3d..10e3e74e94bd6e87565d3240692f721417349c7e 100644 (file)
@@ -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>
  */
 
index 12e7113f3f6188d468226d7977e1d06e4e045b77..b73c6d1af8c29a920f6c084e18028e03db41d751 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example showing how to create a new folder
+ * Create a new IMAP folder
  * </DESC>
  */
 
index 467b06010d914dfa2e04bdf8a001f1cfbb5c6307..693f6b9743bcb0b1ceba8d79be7edaa7c6756ba1 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example showing how to delete a folder
+ * Delete an IMAP folder
  * </DESC>
  */
 
index 68cc636937553bdd72cd1bf28fb4f4b6b52549bc..782dc0fca30066ff56cc804d015ce9fd92eb2fc9 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example showing how to obtain information about a folder
+ * Obtain information about an IMAP folder
  * </DESC>
  */
 
index d6237c3860c00d4c3ceac2123c005379555c070e..9c73e5075448523d508cf465e4b19804322ae716 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example showing how to retreieve emails
+ * Retreieve IMAP emails
  * </DESC>
  */
 
index 85bddac07eaf07a40572fff44d3afdd84b6c598e..d9c01cd001e37aed2e1576003444462faaa129a9 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example to list the folders within a mailbox
+ * List the folders within an IMAP mailbox
  * </DESC>
  */
 
index 1b22fa1e2d7349331c9fa7e5b42874244306f7a3..18de27238038056a8750938453da5070f701bb62 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example to list the subscribed folders
+ * List the subscribed IMAP folders
  * </DESC>
  */
 
index 3b5c633683d2ec3631e0dddf8c77a380cd369594..ace2551d95dcfc1153f566566c3d55c0e9197ef0 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example using the multi interface
+ * Get IMAP email with the multi interface
  * </DESC>
  */
 
index ee1a7772d99e279e1393136496c5a83c183eae65..3c7497d60b59b90c37181462cad0724a21eb9dea 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example showing how to perform a noop
+ * Perform an IMAP noop
  * </DESC>
  */
 
index 7b175b27cf74985d21506580a1a926a9eb4c8bec..b92547474e9ebbf136283b066f420f7fa4dc78f1 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example showing how to search for new emails
+ * Search for new IMAP emails
  * </DESC>
  */
 
index 5b0befbc211505e7a601985620fbe163ae6131e8..bf36e31e2cc7d596c30ad9c3107750818c0033c7 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example using SSL
+ * IMAP with implicit SSL
  * </DESC>
  */
 
index 6a4c756778a14021bf7f8fb6efe49b7096fcc176..571b218d9fdd41833dfe91fd4166d7d74e00b297 100644 (file)
@@ -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>
  */
 
index dbebbc7227cc9580a1cb7fe281ccdf9de1ec6e34..124c04240906b3bf53f5f0ae0f1e58a4c2c0975c 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * IMAP example using TLS
+ * IMAP using TLS
  * </DESC>
  */
 
index 4f2c85574b470241fdf3e66cce6dafe1b167a091..2b89798e39ebabc92241ca4270ebdb962fd8fd0d 100644 (file)
@@ -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>
  */
 
index 8e0c2f2c6eb02e1980581269f3ece9c006aa08d1..168eb76fc26b8b48b2634bdf26b1335a77cc5d49 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example showing how to retrieve emails from a shared mailbox
+ * Retrieve emails from a shared POP3 mailbox
  * </DESC>
  */
 
index d0281cb764125d1f1ffbbae24e55a4ee50cde5c3..7aea644e08464a378cdb72a4125670a1957eec6f 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example showing how to delete emails
+ * Delete POP3 emails
  * </DESC>
  */
 
index 991ff24172fabcd1c2e9c03c8e32800a9055dceb..1dae86ea54ec5ca339154ca86df0bed2b12b50f6 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example to list the contents of a mailbox
+ * List the contents of a POP3 mailbox
  * </DESC>
  */
 
index 69a10885795b7a0ba5fbc361dd3defdb48e83dc2..53d0fd5111338778b107ecfe7c14ed81030db128 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example using the multi interface
+ * Get POP3 email using the multi interface
  * </DESC>
  */
 
index a3ecb8821e1ecc2225d99c7f5e8a8b4f8b00bba2..41c205df5326901e8fa2bbfe84cbf51022a1f997 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example showing how to perform a noop
+ * Perform a POP3 noop
  * </DESC>
  */
 
index 1df0657163f04536d09e808996bfd9f56bb21097..d3866f3aa4f40b3704d8655a41d5f50991ecd04c 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example showing how to retrieve emails
+ * Retrieve POP3 email
  * </DESC>
  */
 
index 6f3455a699d2668cc8b4e3a405d2606534e0efc0..0415363d7d576c3f3601664f335981a437060555 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example using SSL
+ * Get POP3 email using implicit SSL
  * </DESC>
  */
 
index 3df35719d686f0085e32ffce9ad302d976a84820..f78ea5f395a75469357b577d96185776bee763c3 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example showing how to obtain message statistics
+ * Obtain POP3 message statistics
  * </DESC>
  */
 
index d58b5e49a8818e6611b941d20540cdcd0d20e880..3e8d8db3b56f25d563dfdeb20fefc43e01497b40 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * POP3 example using TLS
+ * POP3 using TLS
  * </DESC>
  */
 
index 308de3b441555ec57d8cbc4729e918117e4c05aa..6fa9b210de13d64005b9ccd8d8a5babaa31b4fc8 100644 (file)
@@ -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>
  */
 
index 7da740a095d3e6c63c763a86eac65d9493c5a5a5..954ae810baeed8762b449a249f3bbca5707a8144 100644 (file)
@@ -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>
  */
 
index 6d9d4a4b8340675ffbd973a8d478284b29868eb7..dc2351af1ce87a0b81df1df51b59aa17eed930cb 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * SMTP example showing how to expand an email mailing list
+ * Expand an SMTP email mailing list
  * </DESC>
  */
 
index ce95582b314702867e02b194a950672d6f7ce437..76a91eb4bddb044f2df592a319337165f580bca9 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * SMTP example showing how to send mime emails
+ * Send SMTP mime emails
  * </DESC>
  */
 
index 385827c0c8dd03e255e34095c04692d3370145e7..80b156bd0fc4185e2cc7dfa219a7d14af4d63d05 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * SMTP example using the multi interface
+ * Send SMTP email with the multi interface
  * </DESC>
  */
 
index 70b204591705dd3551353d03214b6ac4f605fb6f..4ccf7686d5524afea01e203dc7013e95f9b6d0dc 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * SMTP example using SSL
+ * Send SMTP email using implicit SSL
  * </DESC>
  */
 
index e30f4788e299aa9269475af9040df6b40babeac8..c33c902def84c9de31f238182ab242f9972df097 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * SMTP example using TLS
+ * Send SMTP email using implicit TLS
  * </DESC>
  */
 
index e6815b6cb1501c369203cceebe01a7d2770f1aa3..d88bfc7d877db90e1477324ead08b83cbb8eb648 100644 (file)
@@ -23,7 +23,7 @@
  ***************************************************************************/
 
 /* <DESC>
- * SMTP example showing how to verify an email address
+ * Verify an SMTP email address
  * </DESC>
  */