]> granicus.if.org Git - curl/commitdiff
curl_imap.h: Tidy up of comments to be more readable
authorSteve Holme <steve_holme@hotmail.com>
Fri, 28 Dec 2012 19:59:14 +0000 (19:59 +0000)
committerSteve Holme <steve_holme@hotmail.com>
Fri, 28 Dec 2012 19:59:14 +0000 (19:59 +0000)
lib/curl_imap.h

index 7200790080fb032c80ebadd00cd159ad4953f4b2..9f509a759c38aaf9996e4a576850ddf7a0a217f5 100644 (file)
@@ -7,7 +7,7 @@
  *                            | (__| |_| |  _ <| |___
  *                             \___|\___/|_| \_\_____|
  *
- * Copyright (C) 2009 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al.
+ * Copyright (C) 2009 - 2012, 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
  * IMAP unique setup
  ***************************************************************************/
 typedef enum {
-  IMAP_STOP,    /* do nothing state, stops the state machine */
-  IMAP_SERVERGREET, /* waiting for the initial greeting immediately after
-                       a connect */
+  IMAP_STOP,         /* do nothing state, stops the state machine */
+  IMAP_SERVERGREET,  /* waiting for the initial greeting immediately after
+                        a connect */
   IMAP_LOGIN,
   IMAP_STARTTLS,
-  IMAP_UPGRADETLS, /* asynchronously upgrade the connection to SSL/TLS
-                      (multi mode only) */
+  IMAP_UPGRADETLS,   /* asynchronously upgrade the connection to SSL/TLS
+                       (multi mode only) */
   IMAP_SELECT,
   IMAP_FETCH,
   IMAP_LOGOUT,
-  IMAP_LAST  /* never used */
+  IMAP_LAST          /* never used */
 } imapstate;
 
 /* imap_conn is used for struct connection-oriented data in the connectdata
    struct */
 struct imap_conn {
   struct pingpong pp;
-  char *mailbox;     /* what to FETCH */
-  imapstate state; /* always use imap.c:state() to change state! */
-  int cmdid;       /* id number/index */
-  const char *idstr; /* pointer to a string for which to wait for as id */
-  bool ssldone;      /* connect() over SSL? only relevant in multi mode */
+  char *mailbox;     /* Message ID to fetch */
+  imapstate state;   /* Always use imap.c:state() to change state! */
+  int cmdid;         /* Next command ID */
+  const char *idstr; /* String based response ID to wait for */
+  bool ssldone;      /* Is connect() over SSL done? Only relevant in
+                        multi mode */
 };
 
 extern const struct Curl_handler Curl_handler_imap;
 extern const struct Curl_handler Curl_handler_imaps;
 
 #endif /* HEADER_CURL_IMAP_H */
-