Commit 3749c70d authored by Nina Džugasová's avatar Nina Džugasová
Browse files

Modiefied String and Array documentations.

parent 6412bea4

src/TNL/Containers/Array.h

+14 −3
Original line number Diff line number Diff line
@@ -21,6 +21,10 @@ template< int, typename > class StaticArray; 


/**

 * Array handles memory allocation and sharing of the same data between more Arrays.

 *

 * \tparam Value Type of array values.

 * \tparam Device Device type.

 * \tparam Index Type of index.

 */

template< typename Value,

          typename Device = Devices::Host,
@@ -35,7 +39,10 @@ class Array : public Object 
      typedef Containers::Array< Value, Devices::Host, Index > HostType;

      typedef Containers::Array< Value, Devices::Cuda, Index > CudaType;



      /** \brief Basic constructor. */

      /** \brief Basic constructor.

       *

       * Constructs an empty array with the size of zero.

       */

      Array();



      /**
@@ -168,14 +175,18 @@ class Array : public Object 
       */

      __cuda_callable__ inline const Value& operator[] ( const Index& i ) const;



      /** Assigns \e array to the given array, replacing its current contents. */

      Array& operator = ( const Array& array );



      /** Assigns \e array to the given array, replacing its current contents. */

      template< typename ArrayT >

      Array& operator = ( const ArrayT& array );



      /** \brief This function checks whether the given array is equal to \e array. */

      template< typename ArrayT >

      bool operator == ( const ArrayT& array ) const;



      /** \brief This function checks whether the given array is not equal to \e array. */

      template< typename ArrayT >

      bool operator != ( const ArrayT& array ) const;

src/TNL/Containers/List.h

+1 −1
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ namespace Containers { 


template< class T > class ListDataElement;



//! Template for double linked lists

/// \brief Template for double linked lists

/*! To acces elements in the list one can use method getSize() and

    operator[](). To add elements there are methods Append(),

    Prepend() and Insert() to insert an element at given

src/TNL/String.h

+4 −2
Original line number Diff line number Diff line
@@ -208,9 +208,11 @@ class String 
      ///

      /// Appends character \e str to this string.

      String& operator+=( char str );

      // \brief This function concatenates strings and returns a newly constructed string object.

      /// \brief This function concatenates strings and returns a newly constructed string object.

      String operator+( char str ) const;

      // \brief This function concatenates strings and returns a newly constructed string object.

      /// \brief This function checks whether the given string is equal to \e str.

      ///

      /// It returns \e true when the given string is equal to \e str. Otherwise returns \e false.

      bool operator==( char str ) const;

      /// \brief This function overloads operator!=().

      bool operator!=( char str ) const;