doxygen: add @brief and capitalize

Remove function name from comment and add @brief instead.
Also capitilize first letter.

Change-Id: Ib708b49bf02e5bc89b0066637a55874e659637e0
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2015-07-01 17:51:40 -04:00
commit f367f071b6
223 changed files with 1146 additions and 1147 deletions

View file

@ -60,7 +60,7 @@
#if (CONFIG_FAULT_DUMP > 0)
/*
* _FaultDump - dump information regarding fault (FAULT_DUMP > 0)
* @brief Dump information regarding fault (FAULT_DUMP > 0)
*
* Dump information regarding the fault when CONFIG_FAULT_DUMP is set to 1
* (short form).
@ -85,7 +85,7 @@ void _FaultDump(const NANO_ESF *esf, int fault)
#endif /* CONFIG_FAULT_DUMP */
/*
* _Fault - fault handler
* @brief Fault handler
*
* This routine is called when fatal error conditions are detected by hardware
* and is responsible only for reporting the error. Once reported, it then