From e9bdfe52766b26b322d51b905df0c3a951f2f638 Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Fri, 22 Nov 2013 04:00:54 +0000 Subject: [PATCH] Corrected description. [SVN r86783] --- doc/ref/array_pop_front.html | 96 +++++++++++++++++------------------- 1 file changed, 44 insertions(+), 52 deletions(-) diff --git a/doc/ref/array_pop_front.html b/doc/ref/array_pop_front.html index bac211a..0c3718d 100644 --- a/doc/ref/array_pop_front.html +++ b/doc/ref/array_pop_front.html @@ -1,59 +1,51 @@ - - BOOST_PP_ARRAY_POP_FRONT - - - -
- The BOOST_PP_ARRAY_POP_FRONT macro pops an element from the end of an array. -
-

Usage

-
- BOOST_PP_ARRAY_POP_FRONT(array) -
-

Arguments

-
-
array
-
- The array to pop an element from. -
-
-

Remarks

-
- This macro returns array after removing the first element.  - If array has no elements, the result of applying this macro is undefined. -
-
- This macro uses BOOST_PP_REPEAT internally.  - Therefore, to use the z parameter passed from other macros that use - BOOST_PP_REPEAT, see BOOST_PP_ARRAY_POP_FRONT_Z -
-

See Also

- -

Requirements

-
- Header:  <boost/preprocessor/array/pop_front.hpp> -
-

Sample Code

-
-#include <boost/preprocessor/array/pop_front.hpp>
+  
+    
+    BOOST_PP_ARRAY_POP_FRONT
+    
+  
+  
+    
 The BOOST_PP_ARRAY_POP_FRONT macro
+      pops an element from the beginning of an array.

+    
Usage

+    
 BOOST_PP_ARRAY_POP_FRONT(array) 

+    
Arguments

+    

+      
array

+      
 The array to pop an element from. 

+    

+    
Remarks

+    
 This macro returns array after removing the first
+      element.  If array has no elements, the result of applying
+      this macro is undefined. 

+    
 This macro uses BOOST_PP_REPEAT internally.  Therefore,
+      to use the z parameter passed from other macros that use BOOST_PP_REPEAT,
+      see BOOST_PP_ARRAY_POP_FRONT_Z 

+    
See Also

+    
+    
Requirements

+    
 Header:  <boost/preprocessor/array/pop_front.hpp>
+    

+    
Sample Code

+    

+      
#include <boost/preprocessor/array/pop_front.hpp>
 
 #define ARRAY (3, (a, b, c))
 
 BOOST_PP_ARRAY_POP_FRONT(ARRAY) // expands to (2, (b, c))
 

-	

-	

-		© Copyright Housemarque Oy 2002
-		
© Copyright Paul Mensonides 2002
-	

-	

-		
Distributed under the Boost Software License, Version 1.0. (See
-		accompanying file LICENSE_1_0.txt or
-		copy at www.boost.org/LICENSE_1_0.txt)

-	

-
+    

+    
 © Copyright Housemarque Oy 2002 

+      © Copyright Paul Mensonides 2002

+      © Copyright Edward Diener 2013

+    

+    

+      
Distributed under the Boost Software License, Version 1.0. (See
+          accompanying file LICENSE_1_0.txt
+          or copy at www.boost.org/LICENSE_1_0.txt)

+    

+