doxygen: Fix many warnings

This commit fixes nearly all of the reported doxygen warnings.

I tried to not clutter the log with removed trailing spaces.
Removed whitespace and converted tab/spaces for all files affected by this commit
are in a separate branch.
This commit is contained in:
Tommy Sparber 2015-10-30 18:55:11 +11:00
parent d0e9cd18c7
commit 938d17576b
34 changed files with 231 additions and 175 deletions

View file

@ -10,12 +10,12 @@
#ifndef ERRORS_H_
#define ERRORS_H_
#ifndef __STSTATUS_TYPE__
#define __STSTATUS_TYPE__
/**
* @brief Return type for St functions.
*/
#ifndef __STSTATUS_TYPE__
#define __STSTATUS_TYPE__
typedef uint8_t StStatus;
typedef uint8_t StStatus;
#endif //__STSTATUS_TYPE__
/**
@ -27,7 +27,7 @@
* @brief Macro used by error-def.h to define all of the return codes.
*
* @param symbol The name of the constant being defined. All St returns
* begin with ST_. For example, ::ST_CONNECTION_OPEN.
* begin with ST_. For example, ::ST_ERR_FATAL.
*
* @param value The value of the return code. For example, 0x61.
*/
@ -36,9 +36,7 @@
enum {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
#include "error-def.h"
#endif //DOXYGEN_SHOULD_SKIP_THIS
/** Gets defined as a count of all the possible return codes in the
* StZNet stack API.
*/