[avr-libc-commit] [2220] 2011-02-22 Eric B.

[Eric Weddington]

Revision: 2220
          http://svn.sv.gnu.org/viewvc/?view=rev&root=avr-libc&revision=2220
Author:   arcanum
Date:     2011-02-22 21:08:58 +0000 (Tue, 22 Feb 2011)
Log Message:
-----------
2011-02-22  Eric B. Weddington  <address@hidden>

        Fix for bug #24861.
        * include/avr/interrupt.h: Remove extra code blocks in documentation.
        Fix spacing.
        * NEWS: Add item to fixed bugs list.

Ticket Links:
:-----------
    http://savannah.gnu.org/bugs/?24861

Modified Paths:
--------------
    trunk/avr-libc/ChangeLog
    trunk/avr-libc/NEWS
    trunk/avr-libc/include/avr/interrupt.h

Modified: trunk/avr-libc/ChangeLog
===================================================================
--- trunk/avr-libc/ChangeLog    2011-02-21 23:26:18 UTC (rev 2219)
+++ trunk/avr-libc/ChangeLog    2011-02-22 21:08:58 UTC (rev 2220)
@@ -1,3 +1,10 @@
+2011-02-22  Eric B. Weddington  <address@hidden>
+
+       Fix for bug #24861.
+       * include/avr/interrupt.h: Remove extra code blocks in documentation.
+       Fix spacing.
+       * NEWS: Add item to fixed bugs list.
+
 2011-02-21  Eric B. Weddington  <address@hidden>
 
        Fix for bug #32103. Thanks to Thomas Rudin for fix.

Modified: trunk/avr-libc/NEWS
===================================================================
--- trunk/avr-libc/NEWS 2011-02-21 23:26:18 UTC (rev 2219)
+++ trunk/avr-libc/NEWS 2011-02-22 21:08:58 UTC (rev 2220)
@@ -2,6 +2,7 @@
 
 * Bugs fixed:
   
+  [#24861] Interrupt documentation contains extra include
   [#32103] Support for Target-Triplets
   [#32419] Incorrect EEPROM size in header for ATxmega192A3
 

Modified: trunk/avr-libc/include/avr/interrupt.h
===================================================================
--- trunk/avr-libc/include/avr/interrupt.h      2011-02-21 23:26:18 UTC (rev 
2219)
+++ trunk/avr-libc/include/avr/interrupt.h      2011-02-22 21:08:58 UTC (rev 
2220)
@@ -67,8 +67,6 @@
 /** \def sei()
     \ingroup avr_interrupts
 
-    \code #include <avr/interrupt.h> \endcode
-
     Enables interrupts by setting the global interrupt mask. This function
     actually compiles into a single line of assembly, so there is no function
     call overhead.  However, the macro also implies a <i>memory barrier</i>
@@ -87,8 +85,6 @@
 /** \def cli()
     \ingroup avr_interrupts
 
-    \code #include <avr/interrupt.h> \endcode
-
     Disables all interrupts by clearing the global interrupt mask. This 
function
     actually compiles into a single line of assembly, so there is no function
     call overhead.  However, the macro also implies a <i>memory barrier</i>
@@ -111,8 +107,6 @@
 /** \def ISR(vector [, attributes])
     \ingroup avr_interrupts
 
-    \code #include <avr/interrupt.h> \endcode
-
     Introduces an interrupt handler function (interrupt service
     routine) that runs with global interrupts initially disabled
     by default with no attributes specified.
@@ -153,8 +147,6 @@
 /** \def SIGNAL(vector)
     \ingroup avr_interrupts
 
-    \code #include <avr/interrupt.h> \endcode
-
     Introduces an interrupt handler function that runs with global interrupts
     initially disabled.
 
@@ -180,8 +172,6 @@
 /** \def EMPTY_INTERRUPT(vector)
     \ingroup avr_interrupts
 
-    \code #include <avr/interrupt.h> \endcode
-
     Defines an empty interrupt handler function. This will not generate
     any prolog or epilog code and will only return from the ISR. Do not
     define a function body as this will define it for you.
@@ -206,8 +196,6 @@
 /** \def ISR_ALIAS(vector, target_vector)
     \ingroup avr_interrupts
 
-    \code #include <avr/interrupt.h> \endcode
-
     Aliases a given vector to another one in the same manner as the
     ISR_ALIASOF attribute for the ISR() macro. Unlike the ISR_ALIASOF
     attribute macro however, this is compatible for all versions of
@@ -231,6 +219,7 @@
 
     ISR_ALIAS(INT1_vect, INT0_vect);
     \endcode 
+    
 */
 #  define ISR_ALIAS(vector, target_vector)
 #else /* real code */
@@ -263,8 +252,6 @@
 /** \def reti()
     \ingroup avr_interrupts
 
-    \code #include <avr/interrupt.h> \endcode
-
     Returns from an interrupt routine, enabling global interrupts. This should
     be the last command executed before leaving an ISR defined with the 
ISR_NAKED
     attribute.
@@ -299,8 +286,6 @@
 /** \def ISR_BLOCK
     \ingroup avr_interrupts
 
-    \code# include <avr/interrupt.h> \endcode
-
     Identical to an ISR with no attributes specified. Global
     interrupts are initially disabled by the AVR hardware when
     entering the ISR, without the compiler modifying this state.
@@ -312,8 +297,6 @@
 /** \def ISR_NOBLOCK
     \ingroup avr_interrupts
 
-    \code# include <avr/interrupt.h> \endcode
-
     ISR runs with global interrupts initially enabled.  The interrupt
     enable flag is activated by the compiler as early as possible
     within the ISR to ensure minimal processing delay for nested
@@ -331,8 +314,6 @@
 /** \def ISR_NAKED
     \ingroup avr_interrupts
 
-    \code# include <avr/interrupt.h> \endcode
-
     ISR is created with no prologue or epilogue code. The user code is
     responsible for preservation of the machine state including the
     SREG register, as well as placing a reti() at the end of the
@@ -345,8 +326,6 @@
 /** \def ISR_ALIASOF(target_vector)
     \ingroup avr_interrupts
 
-    \code#include <avr/interrupt.h>\endcode
-
     The ISR is linked to another ISR, specified by the vect parameter.
     This is compatible with GCC 4.2 and greater only.