bug-mailutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

doc not up-to-date


From: Olivier Bornet
Subject: doc not up-to-date
Date: Tue, 22 Oct 2002 11:41:57 +0200
User-agent: Mutt/1.4i

Hello,

seems lot of functions are not correctly documented in the texinfo
files. The biggest problem (this is my point of view) is the return
values are always documented wrong : there are always
MU_ERROR_INVALID_PARAMETER, but this don't exist in the source files.
For example, mailbox_create () give for return codes :

    - 0
    - MU_ERROR_INVALID_PARAMTER
    - ENOMEM

but, after looking in the sources, the return codes may be (at least) :

    - 0
    - EINVAL
    - MU_ERR_OUT_PTR_NULL
    - ENOMEM
    - MU_ERR_NO_HANDLER

I can understand documentation is not finished. But it's better to have
no documentation then wrong documentation.

Attached is a small patch to correct the return code for
mailbox_create().

Good day.

                Olivier
-- 
Olivier Bornet                      http://www.smartdata.ch/
address@hidden         SMARTDATA SA
Phone: +41-27-723'55'03             Rue du Collège 5A
GPG key ID: C53D9218                CH-1920 Martigny

Attachment: patch-mailutils-doc.txt
Description: Text document

Attachment: pgpRXBCLXdh3z.pgp
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]