Enhanced documentation.
This commit is contained in:
parent
8bb322edb9
commit
dcf7317573
|
@ -27,20 +27,25 @@ extern "C"
|
||||||
#include <stddef.h>
|
#include <stddef.h>
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
|
* @brief C interface for identiconpp.
|
||||||
|
* @file identiconpp_c.h
|
||||||
* @example example.c
|
* @example example.c
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
|
||||||
* @brief C interface for identiconpp.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
* @brief List of identicon algorithms
|
* @brief List of identicon algorithms
|
||||||
*/
|
*/
|
||||||
typedef enum
|
typedef enum
|
||||||
{
|
{
|
||||||
|
//! Generates symmetric (vertically mirrored) identicons.
|
||||||
identiconpp_ltr_symmetric,
|
identiconpp_ltr_symmetric,
|
||||||
|
//! Generates asymmetric identicons.
|
||||||
identiconpp_ltr_asymmetric,
|
identiconpp_ltr_asymmetric,
|
||||||
|
/*!
|
||||||
|
* Generates the same results as
|
||||||
|
* [sigil](https://github.com/cupcake/sigil/) and
|
||||||
|
* [pydenticon](https://github.com/azaghal/pydenticon/).
|
||||||
|
*/
|
||||||
identiconpp_sigil
|
identiconpp_sigil
|
||||||
} identiconpp_algorithm;
|
} identiconpp_algorithm;
|
||||||
|
|
||||||
|
@ -55,7 +60,7 @@ extern "C"
|
||||||
* @param foreground_len Length of the array of foreground colors
|
* @param foreground_len Length of the array of foreground colors
|
||||||
* @param padding Padding in pixels { left & right, top & down }
|
* @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,
|
bool identiconpp_setup(const uint8_t columns, const uint8_t rows,
|
||||||
identiconpp_algorithm type,
|
identiconpp_algorithm type,
|
||||||
|
|
Loading…
Reference in New Issue