Skip to content
Snippets Groups Projects
Commit ea5aee27 authored by Jan Trávníček's avatar Jan Trávníček
Browse files

fix some documentation in strings

parent 30833edc
Branches
Tags
No related merge requests found
...@@ -107,12 +107,12 @@ public: ...@@ -107,12 +107,12 @@ public:
explicit CyclicString ( const Epsilon < SymbolType > & epsilon ); explicit CyclicString ( const Epsilon < SymbolType > & epsilon );
   
/** /**
* @copydoc automaton::AutomatonBase::clone() * @copydoc string::StringBase::clone()
*/ */
virtual StringBase * clone ( ) const override; virtual StringBase * clone ( ) const override;
   
/** /**
* @copydoc automaton::AutomatonBase::plunder() * @copydoc string::StringBase::plunder()
*/ */
virtual StringBase * plunder ( ) && override; virtual StringBase * plunder ( ) && override;
   
...@@ -160,6 +160,8 @@ public: ...@@ -160,6 +160,8 @@ public:
/** /**
* Setter of the string content. * Setter of the string content.
* *
* \throws CommonException when new string contains symbols not present in the alphabet
*
* \param new List of symbols forming string. * \param new List of symbols forming string.
*/ */
void setContent ( ext::vector < SymbolType > str ); void setContent ( ext::vector < SymbolType > str );
...@@ -200,12 +202,12 @@ public: ...@@ -200,12 +202,12 @@ public:
virtual explicit operator std::string ( ) const override; virtual explicit operator std::string ( ) const override;
   
/** /**
* @copydoc alib::GrammarBase::inc() * @copydoc alib::ObjectBase::inc()
*/ */
virtual object::ObjectBase * inc ( ) && override; virtual object::ObjectBase * inc ( ) && override;
   
/** /**
* Type of normalized automaton. * Type of normalized string.
*/ */
typedef CyclicString < > normalized_type; typedef CyclicString < > normalized_type;
}; };
......
...@@ -75,12 +75,12 @@ public: ...@@ -75,12 +75,12 @@ public:
Epsilon ( ext::set < SymbolType > alphabet ); Epsilon ( ext::set < SymbolType > alphabet );
   
/** /**
* @copydoc automaton::AutomatonBase::clone() * @copydoc string::StringBase::clone()
*/ */
virtual StringBase * clone ( ) const override; virtual StringBase * clone ( ) const override;
   
/** /**
* @copydoc automaton::AutomatonBase::plunder() * @copydoc string::StringBase::plunder()
*/ */
virtual StringBase * plunder ( ) && override; virtual StringBase * plunder ( ) && override;
   
...@@ -157,12 +157,12 @@ public: ...@@ -157,12 +157,12 @@ public:
static Epsilon EPSILON; static Epsilon EPSILON;
   
/** /**
* @copydoc alib::GrammarBase::inc() * @copydoc alib::ObjectBase::inc()
*/ */
virtual object::ObjectBase * inc ( ) && override; virtual object::ObjectBase * inc ( ) && override;
   
/** /**
* Type of normalized automaton. * Type of normalized string.
*/ */
typedef Epsilon < > normalized_type; typedef Epsilon < > normalized_type;
}; };
......
...@@ -190,12 +190,12 @@ public: ...@@ -190,12 +190,12 @@ public:
explicit LinearString ( const Epsilon < SymbolType > & epsilon ); explicit LinearString ( const Epsilon < SymbolType > & epsilon );
   
/** /**
* @copydoc automaton::AutomatonBase::clone() * @copydoc string::StringBase::clone()
*/ */
virtual StringBase * clone ( ) const override; virtual StringBase * clone ( ) const override;
   
/** /**
* @copydoc automaton::AutomatonBase::plunder() * @copydoc string::StringBase::plunder()
*/ */
virtual StringBase * plunder ( ) && override; virtual StringBase * plunder ( ) && override;
   
...@@ -250,6 +250,8 @@ public: ...@@ -250,6 +250,8 @@ public:
/** /**
* Setter of the string content. * Setter of the string content.
* *
* \throws CommonException when new string contains symbols not present in the alphabet
*
* \param new List of symbols forming string. * \param new List of symbols forming string.
*/ */
void setContent ( ext::vector < SymbolType > str ); void setContent ( ext::vector < SymbolType > str );
...@@ -290,12 +292,12 @@ public: ...@@ -290,12 +292,12 @@ public:
virtual explicit operator std::string ( ) const override; virtual explicit operator std::string ( ) const override;
   
/** /**
* @copydoc alib::GrammarBase::inc() * @copydoc alib::ObjectBase::inc()
*/ */
virtual object::ObjectBase * inc ( ) && override; virtual object::ObjectBase * inc ( ) && override;
   
/** /**
* Type of normalized automaton. * Type of normalized string.
*/ */
typedef LinearString < > normalized_type; typedef LinearString < > normalized_type;
}; };
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment