Maxim Integrated
Library for the MAX7219 LED display driver
Dependents: MAXREFDES99_demo MAXREFDES99_RTC_Display nucleo_spi_max7219_led8x8 max7219 ... more
Revision 4:b5e4379a3d90, committed 2016-05-12
- Comitter:
- j3
- Date:
- Thu May 12 20:06:28 2016 +0000
- Parent:
- 3:c245060379b9
- Commit message:
- A little more autodoc cleanup
Changed in this revision
| max7219.h | Show annotated file Show diff for this revision Revisions of this file |
diff -r c245060379b9 -r b5e4379a3d90 max7219.h
--- a/max7219.h Thu May 12 19:31:40 2016 +0000
+++ b/max7219.h Thu May 12 20:06:28 2016 +0000
@@ -183,7 +183,8 @@
* @param[in] cs - pin to use for cs
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
Max7219(SPI *spi_bus, PinName cs);
@@ -200,7 +201,8 @@
* @param[in] cs - pin to use for cs
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
Max7219(PinName mosi, PinName miso, PinName sclk, PinName cs);
@@ -213,7 +215,8 @@
* On Entry:
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
~Max7219();
@@ -229,7 +232,8 @@
* used, max of 255
*
* On Exit:
- * @return returns number of devices
+ *
+ * @return Returns number of devices
**************************************************************/
int32_t set_num_devices(uint8_t num_devices);
@@ -242,7 +246,8 @@
* On Entry:
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
void set_display_test(void);
@@ -255,7 +260,8 @@
* On Entry:
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
void clear_display_test(void);
@@ -271,9 +277,10 @@
* data of device
*
* On Exit:
- * @return returns 0 on success
- * returns -1 if device number is > _num_devices
- * returns -2 if device number is 0
+ *
+ * @return Returns 0 on success\n
+ * Returns -1 if device number is > _num_devices\n
+ * Returns -2 if device number is 0\n
**************************************************************/
int32_t init_device(max7219_configuration_t config);
@@ -287,7 +294,8 @@
* @param[in] config - Structure containing configuration
* data
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
void init_display(max7219_configuration_t config);
@@ -301,9 +309,10 @@
* @param[in] device_number - device to enable
*
* On Exit:
- * @return returns 0 on success
- * returns -1 if device number is > _num_devices
- * returns -2 if device number is 0
+ *
+ * @return Returns 0 on success\n
+ * Returns -1 if device number is > _num_devices\n
+ * Returns -2 if device number is 0\n
**************************************************************/
int32_t enable_device(uint8_t device_number);
@@ -316,7 +325,8 @@
* On Entry:
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
void enable_display(void);
@@ -330,9 +340,9 @@
* @param[in] device_number - device to disable
*
* On Exit:
- * @return returns 0 on success,
- * returns -1 if device number is > _num_devices
- * returns -2 if device number is 0
+ * @return Returns 0 on success\n
+ * Returns -1 if device number is > _num_devices\n
+ * Returns -2 if device number is 0\n
**************************************************************/
int32_t disable_device(uint8_t device_number);
@@ -345,7 +355,8 @@
* On Entry:
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
void disable_display(void);
@@ -362,11 +373,12 @@
* @param[in] data - data to write
*
* On Exit:
- * @return returns 0 on success,
- * returns -1 if device number is > _num_devices
- * returns -2 if device number is 0
- * returns -3 if digit > 8
- * returns -4 if digit < 1
+ *
+ * @return Returns 0 on success\n
+ * Returns -1 if device number is > _num_devices\n
+ * Returns -2 if device number is 0\n
+ * Returns -3 if digit > 8\n
+ * Returns -4 if digit < 1\n
**************************************************************/
int32_t write_digit(uint8_t device_number, uint8_t digit, uint8_t data);
@@ -381,11 +393,12 @@
* @param[in] digit - digit to clear
*
* On Exit:
- * @return returns 0 on success,
- * returns -1 if device number is > _num_devices
- * returns -2 if device number is 0
- * returns -3 if digit > 8
- * returns -4 if digit < 1
+ *
+ * @return Returns 0 on success\n
+ * Returns -1 if device number is > _num_devices\n
+ * Returns -2 if device number is 0\n
+ * Returns -3 if digit > 8\n
+ * Returns -4 if digit < 1\n
**************************************************************/
int32_t clear_digit(uint8_t device_number, uint8_t digit);
@@ -399,9 +412,10 @@
* @param[in] device_number - device to write too
*
* On Exit:
- * @return returns 0 on success,
- * returns -1 if device number is > _num_devices
- * returns -2 if device number is 0
+ *
+ * @return Returns 0 on success\n
+ * Returns -1 if device number is > _num_devices\n
+ * Returns -2 if device number is 0\n
**************************************************************/
int32_t device_all_on(uint8_t device_number);
@@ -415,9 +429,10 @@
* @param[in] device_number - device to write too
*
* On Exit:
- * @return returns 0 on success,
- * returns -1 if device number is > _num_devices
- * returns -2 if device number is 0
+ *
+ * @return Returns 0 on success\n
+ * Returns -1 if device number is > _num_devices\n
+ * Returns -2 if device number is 0\n
**************************************************************/
int32_t device_all_off(uint8_t device_number);
@@ -430,7 +445,8 @@
* On Entry:
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
void display_all_on(void);
@@ -443,7 +459,8 @@
* On Entry:
*
* On Exit:
- * @return none
+ *
+ * @return None
**************************************************************/
void display_all_off(void);