From 03d935d088fa0268d1b36072c9745eb1b35b28ce Mon Sep 17 00:00:00 2001 From: hasufell Date: Mon, 26 May 2014 21:59:29 +0200 Subject: [PATCH] ASCII->POLY: improve doxygen comments --- src/ascii_poly.c | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/ascii_poly.c b/src/ascii_poly.c index c8db45a..5ab4d16 100644 --- a/src/ascii_poly.c +++ b/src/ascii_poly.c @@ -45,6 +45,8 @@ * Convert an integer to it's binary representation * as a string and return it. * + * As in: 90 => "10110101" + * * @param value the integer to convert * @return the binary representation as a newly allocated string */ @@ -56,6 +58,10 @@ get_int_to_bin_str(uint8_t value); * integers to the corresponding array of ascii chars, which * is NULL-terminated. * + * It reads in 8bit chunks, as in: + * + * 10110101|00111100|01011001 => 90|60|89 => "Z