mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-07-07 13:29:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation: add compiler abstraction macros to doxygen docs

Browse Source
This commit is contained in:
Dirk Ziegelmeier 2016-12-08 12:45:21 +01:00
parent a420d2530f
commit 8a9ab9968c
1 changed files with 41 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
src/include/lwip/arch.h
View File

@ -47,6 +47,12 @@
#include "arch/cc.h"
/**
* @defgroup compiler_abstraction Compiler/platform abstraction
* @ingroup sys_layer
* @{
*/
/** Define this to 1 in arch/cc.h of your port if you do not want to
* include stddef.h header to get size_t. This cannot be \#defined in
* lwipopts.h since this is not an option of lwIP itself, but an option
@ -166,43 +172,70 @@ typedef uintptr_t mem_ptr_t;
extern "C" {
#endif
/* GCC/clang: Nothing to do */
/** Packed structs support.
* Placed BEFORE declaration of a packed struct. \n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder. \n
* Porting to GCC/clang: Nothing to do.
*/
#ifndef PACK_STRUCT_BEGIN
#define PACK_STRUCT_BEGIN
#endif /* PACK_STRUCT_BEGIN */
/* GCC/clang: Nothing to do */
/** Packed structs support.
* Placed AFTER declaration of a packed struct. \n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder. \n
* Porting to GCC/clang: Nothing to do.
*/
#ifndef PACK_STRUCT_END
#define PACK_STRUCT_END
#endif /* PACK_STRUCT_END */
/* GCC/clang: #define PACK_STRUCT_STRUCT __attribute__((packed)) */
/** Packed structs support.
* Placed between end of declaration of a packed struct and trailing semicolon. \n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder. \n
* Porting to GCC/clang: \#define PACK_STRUCT_STRUCT __attribute__((packed))
*/
#ifndef PACK_STRUCT_STRUCT
#define PACK_STRUCT_STRUCT
#endif /* PACK_STRUCT_STRUCT */
/* GCC/clang: Nothing to do */
/** Packed structs support.
* Wraps u32_t and u16_t members. \n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder. \n
* Porting to GCC/clang: Nothing to do.
*/
#ifndef PACK_STRUCT_FIELD
#define PACK_STRUCT_FIELD(x) x
#endif /* PACK_STRUCT_FIELD */
/* Used for struct fields of u8_t,
* where some compilers warn that packing is not necessary */
/** Packed structs support.
* Wraps u8_t members, where some compilers warn that packing is not necessary. \n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder. \n
* Porting to GCC/clang: Nothing to do.
*/
#ifndef PACK_STRUCT_FLD_8
#define PACK_STRUCT_FLD_8(x) PACK_STRUCT_FIELD(x)
#endif /* PACK_STRUCT_FLD_8 */
/* Used for struct fields of that are packed structs themself,
* where some compilers warn that packing is not necessary */
/** Packed structs support.
* Wraps members that are packed structs themselves, where some compilers warn that packing is not necessary. \n
* For examples of packed struct declarations, see include/lwip/prot/ subfolder. \n
* Porting to GCC/clang: Nothing to do.
*/
#ifndef PACK_STRUCT_FLD_S
#define PACK_STRUCT_FLD_S(x) PACK_STRUCT_FIELD(x)
#endif /* PACK_STRUCT_FLD_S */
/** Eliminates compiler warning about unused arguments. */
#ifndef LWIP_UNUSED_ARG
#define LWIP_UNUSED_ARG(x) (void)x
#endif /* LWIP_UNUSED_ARG */
/**
* @}
*/
#ifdef __cplusplus
}
#endif