message: DOC: Improved FieldVariable documentation.
diff: @@ -223,16 +223,16 @@ public:
  IndexType capacity=USE_DEFAULT );
  #endif
  - /*!
  - * \brief Destructor.
  - */
  - virtual ~FieldVariable( ) { delete m_field; }
  -
  /// @}
  /// \name Virtual Methods
  /// @{
  + /*!
  + * \brief Destructor.
  + */
  + virtual ~FieldVariable( ) { delete m_field; }
  +
  /*!
  * \brief Returns the number of tuples of this FieldVariable instance.
  * \return N the number of tuples of this FieldVariable.
  @@ -269,10 +269,18 @@ public:
  virtual void resize( IndexType newNumTuples ) final override
  { m_field->resize( newNumTuples ); }
  + /*!
  + * \brief Inserts n_tuples with the default value at the given position.
  + *
  + * \param [in] pos the position of the insert.
  + * \param [in] n_tuples the number of tuples to insert.
  + *
  + * \note The values at pos and above are shifted up and the new tuples
  + * have the default values.
  + */
  virtual void emplace( IndexType pos, IndexType num_tuples ) final override
  { m_field->emplace( num_tuples, pos ); }
  -
  /*!
  * \brief Increase the Field capacity to hold the given number of tuples.
  * \param [in] newCapacity number of tuples to reserve memory for.
  @@ -318,6 +326,9 @@ public:
  /// @}
  +/// \name Data Access Methods
  +/// @{
  +
  /*!
  * \brief Returns pointer to the FieldVariable data.
  * \return ptr pointer to the data associated with this field variable.
  @@ -332,6 +343,9 @@ public:
  { return m_field->getData(); }
  /// @}
  +
  +/// @}
  +
  private:
  mint::Array< T >* m_field;
  