Re: documentation of constants

On 9/28/07, Simon Schwarz <[email protected]> wrote:
> Hi there,
>
> am I blind or are constants like "CONNECTION_TYPE_TRY_STARTTLS"
> aren't documented anywhere? If they are please tell me where.
> I know it is not a problem to find them in the source but it is more
> comfortable to have them in the documentation.
>
> If they are not documented, can I help to do so?

Hello,

Documentation is in the source as you suggested. Though, you are
right. This would be nice if it was on the website.
I'll try to take a step to improve the documentation.

<<
enum {
  CONNECTION_TYPE_PLAIN,        /* when the connection is plain text */
  CONNECTION_TYPE_STARTTLS,     /* when the connection is first plain,
                                   then, we want to switch to
                                   TLS (secure connection) */
  CONNECTION_TYPE_TRY_STARTTLS, /* the connection is first plain,
                                   then, we will try to switch to TLS */
  CONNECTION_TYPE_TLS,          /* the connection is over TLS */
  CONNECTION_TYPE_COMMAND,      /* the connection is over a shell command */
  CONNECTION_TYPE_COMMAND_STARTTLS, /* the connection is over a shell
                                       command and STARTTLS will be used */
  CONNECTION_TYPE_COMMAND_TRY_STARTTLS, /* the connection is over
                                           a shell command and STARTTLS will
                                           be tried */
  CONNECTION_TYPE_COMMAND_TLS  /* the connection is over a shell
                                  command in TLS */
};
>>

-- 
DINH Viêt Hoà

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/