[avr-libc-commit] [2505] Forgot to commit this change yesterday (as I accidentally modified

[Joerg Wunsch]

Revision: 2505
          http://svn.sv.gnu.org/viewvc/?view=rev&root=avr-libc&revision=2505
Author:   joerg_wunsch
Date:     2016-02-08 09:37:07 +0000 (Mon, 08 Feb 2016)
Log Message:
-----------
Forgot to commit this change yesterday (as I accidentally modified
delay.h itself rather than delay.h.in).

Modified Paths:
--------------
    trunk/avr-libc/ChangeLog
    trunk/avr-libc/include/util/delay.h.in

Modified: trunk/avr-libc/ChangeLog
===================================================================
--- trunk/avr-libc/ChangeLog    2016-02-07 23:07:50 UTC (rev 2504)
+++ trunk/avr-libc/ChangeLog    2016-02-08 09:37:07 UTC (rev 2505)
@@ -21,6 +21,7 @@
        * include/stdlib.h: (Dito.)
        * include/string.h: (Dito.)
        * include/time.h: (Dito.)
+       * include/util/delay.h.in: (Dito.)
        * libc/pmstring/memchr_P.S: (Dito.)
        * libc/pmstring/memcmp_P.S: (Dito.)
        * libc/pmstring/memcmp_PF.S: (Dito.)

Modified: trunk/avr-libc/include/util/delay.h.in
===================================================================
--- trunk/avr-libc/include/util/delay.h.in      2016-02-07 23:07:50 UTC (rev 
2504)
+++ trunk/avr-libc/include/util/delay.h.in      2016-02-08 09:37:07 UTC (rev 
2505)
@@ -35,9 +35,11 @@
 #ifndef _UTIL_DELAY_H_
 #define _UTIL_DELAY_H_ 1
 
-#ifndef __HAS_DELAY_CYCLES
-#define __HAS_DELAY_CYCLES @HAS_DELAY_CYCLES@
-#endif
+#ifndef __DOXYGEN__
+#  ifndef __HAS_DELAY_CYCLES
+#    define __HAS_DELAY_CYCLES @HAS_DELAY_CYCLES@
+#  endif
+#endif  /* __DOXYGEN__ */
 
 #include <inttypes.h>
 #include <util/delay_basic.h>
@@ -88,6 +90,21 @@
 #ifndef F_CPU
 /* prevent compiler error by supplying a default */
 # warning "F_CPU not defined for <util/delay.h>"
+/** \ingroup util_delay
+    \def F_CPU
+    \brief CPU frequency in Hz
+
+    The macro F_CPU specifies the CPU frequency to be considered by
+    the delay macros.  This macro is normally supplied by the
+    environment (e.g. from within a project header, or the project's
+    Makefile).  The value 1 MHz here is only provided as a "vanilla"
+    fallback if no such user-provided definition could be found.
+
+    In terms of the delay functions, the CPU frequency can be given as
+    a floating-point constant (e.g. 3.6864E6 for 3.6864 MHz).
+    However, the macros in <util/setbaud.h> require it to be an
+    integer value.
+ */
 # define F_CPU 1000000UL
 #endif