Doxygen - another sample, preliminary comments

[Rich Churcher]

Rich Churcher <churcher@ihug.com.au> writes:

> external file.  The file `vector.doc' is attached, as a simple example

Oops - no attachment.  Here's the file contents:

/**
 *  \class _Vector_base
 *  \brief Base class for SGI's std::vector implementation
 *
 *  The vector base class serves two purposes.  First, its constructor
 *  and destructor allocate (but don't initialize) storage.  This makes
 *  exception safety easier.  Second, the base class encapsulates all of
 *  the differences between SGI-style allocators and standard-conforming
 *  allocators. 
 */

/*!
  \class vector
  \brief SGI's std::vector implementation
 
  std::vector - sequence container supporting random access,
  (amortized) constant time insert and erase operations at the end;
  insert and erase in the middle take linear time.  Storage management
  is handled automatically, though hints can be given to improve
  efficiency.
*/

/*!
  \fn size_type vector::capacity() const 
  \brief Returns the total number of elements the vector can hold without reallocation.
*/

/*!
  \fn void vector::reserve(size_type __n)
  \brief Inform a vector of a planned change in size.
*/

/*!
  \fn void vector::resize(size_type __new_size, const _Tp& __x)
  \brief Resize a vector.
*/

/*!
  \fn iterator vector::insert(iterator __position, const _Tp& __x)
  \brief Insert elements.  Reallocate as necessary.
*/

/*!
  \fn iterator vector::erase(iterator __position)
  \brief Erase elements, calling appropriate destructors.
*/
  
/*!
  \fn template <class _Tp, class _Alloc> inline void vector::swap(vector<_Tp, _Alloc>& __x, vector<_Tp, _Alloc>& __y) 
  \brief Swap two vector elements.
*/



-- 
Cheers,
Rich.