From ea5aee27f7d282b40436ab980bb49a4f21f2c1ac Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Tue, 20 Mar 2018 11:31:52 +0100
Subject: [PATCH] fix some documentation in strings

---
 alib2data/src/string/CyclicString.h | 10 ++++++----
 alib2data/src/string/Epsilon.h      |  8 ++++----
 alib2data/src/string/LinearString.h | 10 ++++++----
 3 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/alib2data/src/string/CyclicString.h b/alib2data/src/string/CyclicString.h
index 9a9225ca46..1de92f079b 100644
--- a/alib2data/src/string/CyclicString.h
+++ b/alib2data/src/string/CyclicString.h
@@ -107,12 +107,12 @@ public:
 	explicit CyclicString ( const Epsilon < SymbolType > & epsilon );
 
 	/**
-	 * @copydoc automaton::AutomatonBase::clone()
+	 * @copydoc string::StringBase::clone()
 	 */
 	virtual StringBase * clone ( ) const override;
 
 	/**
-	 * @copydoc automaton::AutomatonBase::plunder()
+	 * @copydoc string::StringBase::plunder()
 	 */
 	virtual StringBase * plunder ( ) && override;
 
@@ -160,6 +160,8 @@ public:
 	/**
 	 * Setter of the string content.
 	 *
+	 * \throws CommonException when new string contains symbols not present in the alphabet
+	 *
 	 * \param new List of symbols forming string.
 	 */
 	void setContent ( ext::vector < SymbolType > str );
@@ -200,12 +202,12 @@ public:
 	virtual explicit operator std::string ( ) const override;
 
 	/**
-	 * @copydoc alib::GrammarBase::inc()
+	 * @copydoc alib::ObjectBase::inc()
 	 */
 	virtual object::ObjectBase * inc ( ) && override;
 
 	/**
-	 * Type of normalized automaton.
+	 * Type of normalized string.
 	 */
 	typedef CyclicString < > normalized_type;
 };
diff --git a/alib2data/src/string/Epsilon.h b/alib2data/src/string/Epsilon.h
index e3a888bca1..56336d20d5 100644
--- a/alib2data/src/string/Epsilon.h
+++ b/alib2data/src/string/Epsilon.h
@@ -75,12 +75,12 @@ public:
 	Epsilon ( ext::set < SymbolType > alphabet );
 
 	/**
-	 * @copydoc automaton::AutomatonBase::clone()
+	 * @copydoc string::StringBase::clone()
 	 */
 	virtual StringBase * clone ( ) const override;
 
 	/**
-	 * @copydoc automaton::AutomatonBase::plunder()
+	 * @copydoc string::StringBase::plunder()
 	 */
 	virtual StringBase * plunder ( ) && override;
 
@@ -157,12 +157,12 @@ public:
 	static Epsilon EPSILON;
 
 	/**
-	 * @copydoc alib::GrammarBase::inc()
+	 * @copydoc alib::ObjectBase::inc()
 	 */
 	virtual object::ObjectBase * inc ( ) && override;
 
 	/**
-	 * Type of normalized automaton.
+	 * Type of normalized string.
 	 */
 	typedef Epsilon < > normalized_type;
 };
diff --git a/alib2data/src/string/LinearString.h b/alib2data/src/string/LinearString.h
index 1ce5176948..0802f1e5a1 100644
--- a/alib2data/src/string/LinearString.h
+++ b/alib2data/src/string/LinearString.h
@@ -190,12 +190,12 @@ public:
 	explicit LinearString ( const Epsilon < SymbolType > & epsilon );
 
 	/**
-	 * @copydoc automaton::AutomatonBase::clone()
+	 * @copydoc string::StringBase::clone()
 	 */
 	virtual StringBase * clone ( ) const override;
 
 	/**
-	 * @copydoc automaton::AutomatonBase::plunder()
+	 * @copydoc string::StringBase::plunder()
 	 */
 	virtual StringBase * plunder ( ) && override;
 
@@ -250,6 +250,8 @@ public:
 	/**
 	 * Setter of the string content.
 	 *
+	 * \throws CommonException when new string contains symbols not present in the alphabet
+	 *
 	 * \param new List of symbols forming string.
 	 */
 	void setContent ( ext::vector < SymbolType > str );
@@ -290,12 +292,12 @@ public:
 	virtual explicit operator std::string ( ) const override;
 
 	/**
-	 * @copydoc alib::GrammarBase::inc()
+	 * @copydoc alib::ObjectBase::inc()
 	 */
 	virtual object::ObjectBase * inc ( ) && override;
 
 	/**
-	 * Type of normalized automaton.
+	 * Type of normalized string.
 	 */
 	typedef LinearString < > normalized_type;
 };
-- 
GitLab