doc: fix flashrom doxygen

cpu/cc430/flashrom.c

@@ -16,7 +16,6 @@
  * @brief       cc430 flashrom driver
  *
  * @author      Kévin Roussel <Kevin.Roussel@inria.fr>
- *
  */
 
 #include <stddef.h>
@@ -28,32 +27,37 @@ static uint8_t prepare(void);
 static void finish(uint8_t istate);
 static inline void busy_wait(void);
 
-/*---------------------------------------------------------------------------*/
+/**
+ * @TODO implement this function
+ */
 uint8_t flashrom_erase(uint8_t *addr)
 {
-    // TODO implement this function
     return 0;
 }
-/*---------------------------------------------------------------------------*/
+
+/**
+ * @TODO implement this function
+ */
 uint8_t flashrom_write(uint8_t *dst, const uint8_t *src, size_t size)
 {
-    // TODO implement this function
     return 0;
 }
 
-/*---------------------------------------------------------------------------*/
+/**
+ * @TODO implement this function
+ */
 static uint8_t prepare(void)
 {
-    // TODO implement this function
-
     return 0;
 }
-/*---------------------------------------------------------------------------*/
+
+/**
+ * @TODO implement this function
+ */
 void finish(uint8_t istate)
 {
-    // TODO implement this function
 }
-/*---------------------------------------------------------------------------*/
+
 static inline void busy_wait(void)
 {
     /* Wait for BUSY = 0, not needed unless run from RAM */

drivers/include/flashrom.h

@@ -1,11 +1,12 @@
-/*
+/**
  * @defgroup    flashrom Flash memory driver
  * @ingroup     drivers
  * @brief       Generic flash memory driver
  * @{
  *
- * @file        flashrom.h
+ * @file
  *
+ * @brief       Generic flash memory driver
  * @author      unknown
  */
 
@@ -15,24 +16,25 @@
 #include <stdint.h>
 #include <stddef.h>
 
-/*
+/**
  * @brief Erase sector
  *
- * @param addr      Address within a flash sector to erase
+ * @param[out] addr Address within a flash sector to erase
  *
  * @return          1 on success, 0 otherwise
  */
 uint8_t             flashrom_erase(uint8_t *addr);
 
-/* @brief Write buffer from ram to flash
+/**
+ * @brief Write buffer from ram to flash
  *
- * @param dst       Address within a flash sector to write, must be a 256 byte boundary
- * @param src       Address within ram, must be a word boundary
- * @param size      Bytes to write
+ * @param[out] dst  Address within a flash sector to write, must be a 256 byte boundary
+ * @param[in] src   Address within ram, must be a word boundary
+ * @param[in] size  Bytes to write
  *
  * @return          1 on success, 0 otherwise
  */
 uint8_t             flashrom_write(uint8_t *dst, const uint8_t *src, size_t size);
 
-/** @} */
 #endif /* FLASHROM_H */
+/** @} */