From dcf731757300e7f5d522b6c770f4d0378673e274 Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 4 Jan 2019 20:35:28 +0100 Subject: [PATCH] Enhanced documentation. --- src/identiconpp_c.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/src/identiconpp_c.h b/src/identiconpp_c.h index eb20200..1a0699a 100644 --- a/src/identiconpp_c.h +++ b/src/identiconpp_c.h @@ -27,20 +27,25 @@ extern "C" #include /*! + * @brief C interface for identiconpp. + * @file identiconpp_c.h * @example example.c */ - /*! - * @brief C interface for identiconpp. - */ - /*! * @brief List of identicon algorithms */ typedef enum { + //! Generates symmetric (vertically mirrored) identicons. identiconpp_ltr_symmetric, + //! Generates asymmetric identicons. identiconpp_ltr_asymmetric, + /*! + * Generates the same results as + * [sigil](https://github.com/cupcake/sigil/) and + * [pydenticon](https://github.com/azaghal/pydenticon/). + */ identiconpp_sigil } identiconpp_algorithm; @@ -55,7 +60,7 @@ extern "C" * @param foreground_len Length of the array of foreground colors * @param padding Padding in pixels { left & right, top & down } * - * @return false on error. + * @return false on error, true otherwise. */ bool identiconpp_setup(const uint8_t columns, const uint8_t rows, identiconpp_algorithm type,