* Foundation
*/
-
#ifndef __OS_ZLIB_H
#define __OS_ZLIB_H
-#include "zlib.h"
-
-/**
- * @brief Compress a string with zlib.
- * @param[in] src the source string to compress
- * @param[out] dst the destination buffer for the compressed string, will be null-terminated on success
- * @param[in] src_size the length of the source string
- * @param[in] dst_size the size of the destination buffer
- * @return 0 on failure, else the length of the compressed string
+/* Compress a string with zlib
+ * src: the source string to compress
+ * dst: the destination buffer for the compressed string, will be
+ * null-terminated on success
+ * src_size: the length of the source string
+ * dst_size: the size of the destination buffer
+ * Returns 0 on failure, else the length of the compressed string
*/
-unsigned long int os_zlib_compress(const char *src, char *dst, unsigned long int src_size,
- unsigned long int dst_size);
+unsigned long int os_zlib_compress(const char *src, char *dst,
+ unsigned long int src_size,
+ unsigned long int dst_size);
-/**
- * @brief Uncompress a string with zlib.
- * @param[in] src the source string to uncompress
- * @param[out] dst the destination buffer for the uncompressed string, will be null-terminated on success
- * @param[in] src_size the length of the source string
- * @param[in] dst_size the size of the destination buffer
- * @return 0 on failure, else the length of the uncompressed string
+/* Uncompress a string with zlib
+ * src: the source string to uncompress
+ * dst: the destination buffer for the uncompressed string, will be
+ * null-terminated on success
+ * src_size: the length of the source string
+ * dst_size: the size of the destination buffer
+ * Returns 0 on failure, else the length of the uncompressed string
*/
-unsigned long int os_zlib_uncompress(const char *src, char *dst, unsigned long int src_size,
- unsigned long int dst_size);
+unsigned long int os_zlib_uncompress(const char *src, char *dst,
+ unsigned long int src_size,
+ unsigned long int dst_size);
#endif /* __OS_ZLIB_H */
-/* EOF */