[adobe-source-commits] sandbox/adobe-source/adobe/documentation/sources/asl array_t.dox,1.1,1.2

[Foster B. <fos...@us...>]

Update of /cvsroot/adobe-source/sandbox/adobe-source/adobe/documentation/sources/asl
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4121/adobe/documentation/sources/asl

Modified Files:
	array_t.dox 
Log Message:
bug fixes, additions to array_t, documentation update

Index: array_t.dox
===================================================================
RCS file: /cvsroot/adobe-source/sandbox/adobe-source/adobe/documentation/sources/asl/array_t.dox,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** array_t.dox	19 Mar 2005 00:16:41 -0000	1.1
--- array_t.dox	31 Mar 2005 18:51:00 -0000	1.2
***************
*** 3,7 ****
  \ingroup asl_libraries
  
! \brief A copy-on-write array of <code>adobe::value_t</code>s.
  
  array_t is an array of heterogeneous types. array_t is copy-on-write, intended for usage where copies are frequent, but writing is infrequent. Constructing an empty array will never throw an exception - no allocations are required until something is stored into it. Likewise, copying with assignment or copy constructor will not throw.
--- 3,7 ----
  \ingroup asl_libraries
  
! \brief A copy-on-write array of <code>adobe::value_t</code>.
  
  array_t is an array of heterogeneous types. array_t is copy-on-write, intended for usage where copies are frequent, but writing is infrequent. Constructing an empty array will never throw an exception - no allocations are required until something is stored into it. Likewise, copying with assignment or copy constructor will not throw.
***************
*** 13,17 ****
  	When copy-on-write semantics are not important, it is advised to use <code>std::vector<adobe::value_t></code> or another container type instead of array_t.
  
! \todo (sparent) We don't have all the random access iterator requirements met yet.
  
  \tutorial
--- 13,18 ----
  	When copy-on-write semantics are not important, it is advised to use <code>std::vector<adobe::value_t></code> or another container type instead of array_t.
  
! \note
! 	\anchor _1 [1] Because an array_t is copy-on-write, modifications through an iterator are not supported except via back_insert_iterator.
  
  \tutorial
***************
*** 31,72 ****
  /*!
  \typedef adobe::array_t::value_type
! The type of object, <code>T</code>, stored in the <code>array_t</code>.
  */
  
  /*!
  \typedef adobe::array_t::reference
! Reference to <code>T</code>.
  */
  
  /*!
  \typedef adobe::array_t::const_reference
! Const reference to <code>T</code>.
  */
  
  /*!
  \typedef adobe::array_t::pointer
! Pointer to <code>T</code>.
  */
  
  /*!
  \typedef adobe::array_t::const_pointer
! Const pointer to <code>T</code>.
  */
  
  /*!
! \typedef adobe::array_t::const_reverse_iterator
! Const reverse_iterator into elements in the array.
  */
  
  /*!
! \fn adobe::array_t::array_t(size_type n, const value_t& item)
  
! Initializes the array_t with <code>n</code> items of value <code>item</code>.
  */
  
  /*!
! \fn adobe::array_t::array_t(InputIterator first, InputIterator last)
  
! Copies the elements within <code>(first, last]</code> into the array.
  */
  
--- 32,82 ----
  /*!
  \typedef adobe::array_t::value_type
! The type of object, <code>adobe::value_t</code>, stored in the <code>array_t</code>.
  */
  
  /*!
  \typedef adobe::array_t::reference
! Reference to <code>adobe::value_t</code>.
  */
  
  /*!
  \typedef adobe::array_t::const_reference
! Const reference to <code>adobe::value_t</code>.
  */
  
  /*!
  \typedef adobe::array_t::pointer
! Pointer to <code>adobe::value_t</code>.
  */
  
  /*!
  \typedef adobe::array_t::const_pointer
! Const pointer to <code>adobe::value_t</code>.
  */
  
  /*!
! \typedef adobe::array_t::iterator
! A random access iterator for the array \ref _1 "[1]".
  */
  
  /*!
! \typedef adobe::array_t::const_iterator
! Equivalent to <code>array_t::iterator</code>.
! */
  
! /*!
! \typedef adobe::array_t::reverse_iterator
! A reverse iterator into the array \ref _1 "[1]".
  */
  
  /*!
! \typedef adobe::array_t::const_reverse_iterator
! Equivalent to <code>array_t:: reverse_iterator</code>.
! */
  
! /*!
! \fn adobe::array_t::array_t(size_type n, const value_t& item)
! 
! Initializes the array_t with <code>n</code> items of value <code>item</code>.
  */
  
***************
*** 270,271 ****
--- 280,293 ----
  	<code>true</code> if this array is the only one referrring to its implementation instance (i.e., the implementation instance is currently not being shared). <code>false</code> otherwise.
  */
+ 
+ /*!
+ \class adobe::array_t::back_insert_iterator array.hpp <adobe/array.hpp>
+ \ingroup asl_libraries
+ 
+ \brief a back insert iterator for appending to array_t.
+ 
+ Assignment through a <code>back_insert_iterator</code> will insert an object after the last element of an <code>array_t</code>.
+ 
+ \model_of
+ 	- \ref output_iterator
+ */