]> rtime.felk.cvut.cz Git - pes-rpp/rpp-lib.git/commitdiff
Wordwrap and clarify documentation of rpp_init()
authorMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 20 Nov 2014 18:21:11 +0000 (19:21 +0100)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 20 Nov 2014 18:22:10 +0000 (19:22 +0100)
rpp/include/rpp/rpp.h

index 3ebb837f70d234f74af6fe5fc7007ee8ceb0897a..4068ea48861731a402f04d0b16a0a873056c7bd5 100644 (file)
 /**
  * Library initialization function.
  *
- * This is a convenience function, which should be called only if all of the peripherals are going to be used by
- * the software.
- *
- * To initialize the selected peripherals only, call the rpp_periph_init() function for each one of them instead
- * of this function.
+ * This is a convenience function, that initializes all peripherals.
+ * If the application does not use all the peripherals it is better to
+ * call directly the rpp_<periph>_init() functions for the used
+ * peripherals as the resulting binary will be smaller.
  *
  * @return SUCCESS if initialization successful.\n
  *          FAILURE is library was already initialized.