common: Improve a function's documentation and comments.
[gnupg.git] / common / zb32.h
1 /* zb32.h - z-base-32 functions
2  * Copyright (C) 2014  Werner Koch
3  *
4  * This file is part of GnuPG.
5  *
6  * This file is free software; you can redistribute it and/or modify
7  * it under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * This file is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, see <http://www.gnu.org/licenses/>.
28  */
29
30 #ifndef GNUPG_COMMON_ZB32_H
31 #define GNUPG_COMMON_ZB32_H
32
33 /* Encode DATA which has a length of DATABITS (bits!) using the
34    zbase32 encoder and return a malloced string.  Returns NULL on
35    error and sets ERRNO.  */
36 char *zb32_encode (const void *data, unsigned int databits);
37
38 #endif /*GNUPG_COMMON_ZB32_H*/