From 955e99f0179f6c7b7c7baa6923b00f613cf29206 Mon Sep 17 00:00:00 2001
From: Nina Dzugasova <dzugasova.nina@gmail.com>
Date: Thu, 25 Oct 2018 16:07:37 +0200
Subject: [PATCH] Added first examples into String.
---
src/TNL/String.h | 36 ++++++++++++++----------------------
1 file changed, 14 insertions(+), 22 deletions(-)
diff --git a/src/TNL/String.h b/src/TNL/String.h
index 20b065ba24..9625554ad2 100644
--- a/src/TNL/String.h
+++ b/src/TNL/String.h
@@ -25,7 +25,13 @@ class String;
template< typename T >
String convertToString( const T& value );
-
+/////
+/// \brief Class for managing strings.
+///
+/// \par Example
+/// \include StringExample.cpp
+/// \par Output
+/// \include StringOutput.cpp
class String
{
public:
@@ -34,10 +40,6 @@ class String
/// \brief Basic constructor.
///
/// Constructs an empty string object with the length of zero characters.
- /// \par Example
- /// \include StringExample.cpp
- /// \par Output
- /// str1 = \n str2 =
String();
/////
@@ -51,12 +53,6 @@ class String
/// to be omitted from the string \e c.
/// @param sufix_cut_off Determines the length of the sufix that is going
/// to be omitted from the string \e c.
- ///
- /// \par Example
- /// \code String str( "xxstringxxx", 2, 3 ); \endcode
- ///
- /// \par Output
- /// str = string
String( const char* c,
int prefix_cut_off = 0,
int sufix_cut_off = 0 );
@@ -73,17 +69,12 @@ class String
/// \brief Copy constructor.
///
/// Constructs a copy of the string \e str.
- ///
- /// \par Example
- /// \code
- String str1( "Something" );
- String str2( str1 );
- /// \endcode
- /// \par Output
- /// str1 = Something \n str2 = Something
String( const String& str );
- /// Converts anything to a string.
+ /// \brief Converts anything to a string.
+ ///
+ /// This function converts any type of value into type string.
+ /// @param value Word of any type (e.g. int, bool, double,...).
template< typename T >
String( T value )
: string( nullptr ), length( 0 )
@@ -106,6 +97,7 @@ class String
/////
/// Reserves space for given \e size.
/// Requests to allocate storage for given \e size.
+ /// It allocates one more byte for the terminating 0.
/// @param size Number of characters.
void setSize( int size );
@@ -264,7 +256,7 @@ class String
bool load( File& file );
- // Mozem dat prec??? !!!!
+ // !!! Mozem dat prec???
// Broadcast to other nodes in MPI cluster
// void MPIBcast( int root, MPI_Comm mpi_comm = MPI_COMM_WORLD );
@@ -286,7 +278,7 @@ class String
/// Length of allocated piece of memory.
int length;
-};
+}; // class String
/// Returns concatenation of \e string1 and \e string2.
String operator+( char string1, const String& string2 );
--
GitLab