Fix up references in the LEDNotifier project to the old HotmailNotifier name.

[pub/USBasp.git] / LUFA / Common / FunctionAttributes.h

diff --git a/LUFA/Common/FunctionAttributes.h b/LUFA/Common/FunctionAttributes.h
index 16503bb..61246b8 100644 (file)
--- a/LUFA/Common/FunctionAttributes.h
+++ b/LUFA/Common/FunctionAttributes.h
@@ -32,11 +32,22 @@
  *\r
  *  This file contains macros for applying GCC specific attributes to functions to control various optimizer\r
  *  and code generation features of the compiler. Attributes may be placed in the function prototype in any\r
  *\r
  *  This file contains macros for applying GCC specific attributes to functions to control various optimizer\r
  *  and code generation features of the compiler. Attributes may be placed in the function prototype in any\r

- *  order, and multiple attributes can be specified for a single function via a space seperated list.\r
+ *  order, and multiple attributes can be specified for a single function via a space separated list.\r
+ *\r
+ *  On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are\r
+ *  critical to the code's function and thus must throw a compiler error when used.\r

  *\r
  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's\r
  *        functionality.\r
  */\r
  *\r
  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's\r
  *        functionality.\r
  */\r

+ \r
+/** \ingroup Group_Common\r
+ *  @defgroup Group_FuncAttr Function Attributes\r
+ *\r
+ *  Macros for easy access GCC function attributes, which can be applied to function prototypes.\r
+ *\r
+ *  @{\r
+ */\r

 \r
 #ifndef __FUNCATTR_H__\r
 #define __FUNCATTR_H__\r
 \r
 #ifndef __FUNCATTR_H__\r
 #define __FUNCATTR_H__\r


@@ -48,63 +59,66 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r

-                       /** Indicates to the compiler that the function can not ever return, so that any stack restoring or\r
-                        *  return code may be ommited by the compiler in the resulting binary.\r
-                        */\r
-                       #define ATTR_NO_RETURN              __attribute__ ((noreturn))\r
+                       #if (__GNUC__ >= 3) || defined(__DOXYGEN__)\r
+                               /** Indicates to the compiler that the function can not ever return, so that any stack restoring or\r
+                                *  return code may be omitted by the compiler in the resulting binary.\r
+                                */\r
+                               #define ATTR_NO_RETURN              __attribute__ ((noreturn))\r
+                               \r
+                               /** Indicates that the function returns a value which should not be ignored by the user code. When\r
+                                *  applied, any ignored return value from calling the function will produce a compiler warning.\r
+                                */\r
+                               #define ATTR_WARN_UNUSED_RESULT     __attribute__ ((warn_unused_result))\r

 \r
 \r

-                       /** Places the function in one of the initilization sections, which execute before the main function\r
-                        *  of the application. The init function number can be specified as "x", as an integer. Refer to the\r
-                        *  avr-libc manual for more information on the initialization sections.\r
-                        */\r
-                       #define ATTR_INIT_SECTION(x)        __attribute__ ((naked, section (".init" #x )))\r
-                       \r
-                       /** Indicates that the function returns a value which should not be ignored by the user code. When\r
-                        *  applied, any ignored return value from calling the function will produce a compiler warning.\r
-                        */\r
-                       #define ATTR_WARN_UNUSED_RESULT     __attribute__ ((warn_unused_result))\r
+                               /** Indicates that the specified parameters of the function are pointers which should never be NULL.\r
+                                *  When applied as a 1-based comma separated list the compiler will emit a warning if the specified\r
+                                *  parameters are known at compiler time to be NULL at the point of calling the function.\r
+                                */\r
+                               #define ATTR_NON_NULL_PTR_ARG(...)  __attribute__ ((nonnull (__VA_ARGS__)))\r

 \r
 \r

-                       /** Indicates that the specified parameters of the function are pointers which should never be NULL.\r
-                        *  When applied as a 1-based comma seperated list the compiler will emmit a warning if the specified\r
-                        *  parameters are known at compiler time to be NULL at the point of calling the function.\r
-                        */\r
-                       #define ATTR_NON_NULL_PTR_ARG(...)  __attribute__ ((nonnull (__VA_ARGS__)))\r
+                               /** Removes any preamble or postamble from the function. When used, the function will not have any\r
+                                *  register or stack saving code. This should be used with caution, and when used the programmer\r
+                                *  is responsible for maintaining stack and register integrity.\r
+                                */\r
+                               #define ATTR_NAKED                  __attribute__ ((naked))\r
+                               \r
+                               /** Prevents the compiler from considering a specified function for inlining. When applied, the given\r
+                                *  function will not be inlined under any circumstances.\r
+                                */\r
+                               #define ATTR_NO_INLINE              __attribute__ ((noinline))\r

 \r
 \r

-                       /** Removes any preample or postample from the function. When used, the function will not have any\r
-                        *  register or stack saving code. This should be used with caution, and when used the programmer\r
-                        *  is responsible for maintaining stack and register integrity.\r
-                        */\r
-                       #define ATTR_NAKED                  __attribute__ ((naked))\r
-                       \r
-                       /** Prevents the compiler from considering a specified function for inlining. When applied, the given\r
-                        *  function will not be inlined under any circumstances.\r
-                        */\r
-                       #define ATTR_NOINLINE               __attribute__ ((noinline))\r
+                               /** Forces the compiler to inline the specified function. When applied, the given function will be\r
+                                *  inlined under all circumstances.\r
+                                */\r
+                               #define ATTR_ALWAYS_INLINE          __attribute__ ((always_inline))\r
+                               \r
+                               /** Indicates that the specified function is pure, in that it has no side-effects other than global\r
+                                *  or parameter variable access.\r
+                                */\r
+                               #define ATTR_PURE                   __attribute__ ((pure))\r
+                               \r
+                               /** Indicates that the specified function is constant, in that it has no side effects other than\r
+                                *  parameter access.\r
+                                */\r
+                               #define ATTR_CONST                  __attribute__ ((const))\r
+                               \r
+                               /** Marks a given function as deprecated, which produces a warning if the function is called. */\r
+                               #define ATTR_DEPRECATED             __attribute__ ((deprecated))\r
+                               \r
+                               /** Marks a function as a weak reference, which can be overridden by other functions with an\r
+                                *  identical name (in which case the weak reference is discarded at link time).\r
+                                */\r
+                               #define ATTR_WEAK                   __attribute__ ((weak))\r
+                       #endif\r

 \r
 \r

-                       /** Forces the compiler to inline the specified function. When applied, the given function will be\r
-                        *  inlined under all circumstances.\r
-                        */\r
-                       #define ATTR_ALWAYSINLINE           __attribute__ ((always_inline))\r
-                       \r
-                       /** Indicates that the specified function is pure, in that it has no side-effects other than global\r
-                        *  or parameter variable access.\r
-                        */\r
-                       #define ATTR_PURE                   __attribute__ ((pure))\r
-                       \r
-                       /** Indicates that the specified function is constant, in that it has no side effects other than\r
-                        *  parameter access.\r
-                        */\r
-                       #define ATTR_CONST                  __attribute__ ((const))\r
-                       \r
-                       /** Marks a given function as deprecated, which produces a warning if the function is called. */\r
-                       #define ATTR_DEPRECATED             __attribute__ ((deprecated))\r
-                       \r
-                       /** Marks a function as a weak reference, which can be overridden by other functions with an\r
-                        *  identical name (in which case the weak reference is discarded at link time).\r
+                       /** Places the function in one of the initialization sections, which execute before the main function\r
+                        *  of the application. The init function number can be specified as "x", as an integer. Refer to the\r
+                        *  avr-libc manual for more information on the initialization sections.\r

                         */\r
                         */\r

-                       #define ATTR_WEAK                   __attribute__ ((weak))\r
+                       #define ATTR_INIT_SECTION(x)        __attribute__ ((naked, section (".init" #x )))\r

                        \r
                        /** Marks a function as an alias for another function of name "x". */\r
                        #define ATTR_ALIAS(x)               __attribute__ ((alias( #x )))\r
                        \r
                        /** Marks a function as an alias for another function of name "x". */\r
                        #define ATTR_ALIAS(x)               __attribute__ ((alias( #x )))\r

-               \r

 #endif\r
 #endif\r

+\r
+/** @} */\r