From bab338e201bd8cf1a60ed48eabbe641d87d5d7ac Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Fri, 15 Jun 2018 22:47:19 +0200
Subject: [PATCH] document base classes

---
 alib2data/src/alphabet/SymbolBase.h     | 18 ++++++++++++++----
 alib2data/src/automaton/AutomatonBase.h | 13 ++++++++++---
 alib2data/src/label/LabelBase.h         | 18 ++++++++++++++----
 alib2data/src/regexp/RegExpBase.h       | 13 ++++++++++---
 alib2data/src/rte/RTEBase.h             |  7 +++++--
 alib2data/src/string/StringBase.h       | 13 ++++++++++---
 alib2data/src/tree/TreeBase.h           | 13 ++++++++++---
 7 files changed, 73 insertions(+), 22 deletions(-)

diff --git a/alib2data/src/alphabet/SymbolBase.h b/alib2data/src/alphabet/SymbolBase.h
index 07b56ab4fa..bb98b3e2ac 100644
--- a/alib2data/src/alphabet/SymbolBase.h
+++ b/alib2data/src/alphabet/SymbolBase.h
@@ -13,14 +13,24 @@
 namespace alphabet {
 
 /**
- * Represents symbol in an alphabet.
+ * \brief Represents base for a concrete symbol type.
  */
 class SymbolBase : public object::ObjectBase {
 public:
-	virtual SymbolBase* clone ( ) const & = 0;
-	virtual SymbolBase* clone() && = 0;
+	/**
+	 * @copydoc ObjectBase::clone ( ) const &
+	 */
+	virtual SymbolBase * clone ( ) const & override = 0;
 
-	virtual SymbolBase* inc() && = 0;
+	/**
+	 * @copydoc ObjectBase::clone ( ) &&
+	 */
+	virtual SymbolBase * clone ( ) && override = 0;
+
+	/**
+	 * @copydoc ObjectBase::inc ( ) &&
+	 */
+	virtual SymbolBase * inc ( ) && override = 0;
 };
 
 } /* namespace alphabet */
diff --git a/alib2data/src/automaton/AutomatonBase.h b/alib2data/src/automaton/AutomatonBase.h
index 78b3559939..4cd65707ef 100644
--- a/alib2data/src/automaton/AutomatonBase.h
+++ b/alib2data/src/automaton/AutomatonBase.h
@@ -13,12 +13,19 @@
 namespace automaton {
 
 /**
- * Represents symbol in an alphabet.
+ * \brief Represents base for a concrete automaton type.
  */
 class AutomatonBase : public object::ObjectBase {
 public:
-	virtual AutomatonBase* clone ( ) const & = 0;
-	virtual AutomatonBase* clone() && = 0;
+	/**
+	 * @copydoc ObjectBase::clone ( ) const &
+	 */
+	virtual AutomatonBase * clone ( ) const & override = 0;
+
+	/**
+	 * @copydoc ObjectBase::clone ( ) &&
+	 */
+	virtual AutomatonBase * clone() && override = 0;
 };
 
 } /* namespace automaton */
diff --git a/alib2data/src/label/LabelBase.h b/alib2data/src/label/LabelBase.h
index 4fa13c1722..484493ad3a 100644
--- a/alib2data/src/label/LabelBase.h
+++ b/alib2data/src/label/LabelBase.h
@@ -13,14 +13,24 @@
 namespace label {
 
 /**
- * Represents symbol in an alphabet.
+ * \brief Represents base for a concrete label type.
  */
 class LabelBase : public object::ObjectBase {
 public:
-	virtual LabelBase* clone ( ) const & = 0;
-	virtual LabelBase* clone() && = 0;
+	/**
+	 * @copydoc ObjectBase::clone ( ) const &
+	 */
+	virtual LabelBase * clone ( ) const & override = 0;
 
-	virtual LabelBase* inc() && = 0;
+	/**
+	 * @copydoc ObjectBase::clone ( ) &&
+	 */
+	virtual LabelBase * clone ( ) && override = 0;
+
+	/**
+	 * @copydoc ObjectBase::inc ( ) &&
+	 */
+	virtual LabelBase * inc ( ) && override = 0;
 };
 
 } /* namespace label */
diff --git a/alib2data/src/regexp/RegExpBase.h b/alib2data/src/regexp/RegExpBase.h
index 9fed23171a..43308585d8 100644
--- a/alib2data/src/regexp/RegExpBase.h
+++ b/alib2data/src/regexp/RegExpBase.h
@@ -13,12 +13,19 @@
 namespace regexp {
 
 /**
- * Represents symbol in an alphabet.
+ * \brief Represents base for a concrete regexp type.
  */
 class RegExpBase : public object::ObjectBase {
 public:
-	virtual RegExpBase* clone ( ) const & = 0;
-	virtual RegExpBase* clone() && = 0;
+	/**
+	 * @copydoc ObjectBase::clone ( ) const &
+	 */
+	virtual RegExpBase * clone ( ) const & override = 0;
+
+	/**
+	 * @copydoc ObjectBase::clone ( ) &&
+	 */
+	virtual RegExpBase* clone() && override = 0;
 };
 
 } /* namespace regexp */
diff --git a/alib2data/src/rte/RTEBase.h b/alib2data/src/rte/RTEBase.h
index 1fcafe974b..1729f0ad9a 100644
--- a/alib2data/src/rte/RTEBase.h
+++ b/alib2data/src/rte/RTEBase.h
@@ -12,17 +12,20 @@
 
 namespace rte {
 
+/**
+ * \brief Represents base for a concrete rte type.
+ */
 class RTEBase : public object::ObjectBase {
 public:
 	/**
 	 * @copydoc object::ObjectBase::clone ( ) const &
 	 */
-	virtual RTEBase * clone ( ) const & = 0;
+	virtual RTEBase * clone ( ) const & override = 0;
 
 	/**
 	 * @copydoc object::ObjectBase::clone ( ) &&
 	 */
-	virtual RTEBase * clone ( ) &&  = 0;
+	virtual RTEBase * clone ( ) && override = 0;
 };
 
 } /* namespace rte */
diff --git a/alib2data/src/string/StringBase.h b/alib2data/src/string/StringBase.h
index 938e9a3957..b172cd64ea 100644
--- a/alib2data/src/string/StringBase.h
+++ b/alib2data/src/string/StringBase.h
@@ -13,12 +13,19 @@
 namespace string {
 
 /**
- * Represents symbol in an alphabet.
+ * \brief Represents base for a concrete string type.
  */
 class StringBase : public object::ObjectBase {
 public:
-	virtual StringBase * clone ( ) const & = 0;
-	virtual StringBase * clone ( ) && = 0;
+	/**
+	 * @copydoc ObjectBase::clone ( ) const &
+	 */
+	virtual StringBase * clone ( ) const & override = 0;
+
+	/**
+	 * @copydoc ObjectBase::clone ( ) &&
+	 */
+	virtual StringBase * clone ( ) && override = 0;
 };
 
 } /* namespace string */
diff --git a/alib2data/src/tree/TreeBase.h b/alib2data/src/tree/TreeBase.h
index ccdedd35cb..3e2ca4ebf7 100644
--- a/alib2data/src/tree/TreeBase.h
+++ b/alib2data/src/tree/TreeBase.h
@@ -13,12 +13,19 @@
 namespace tree {
 
 /**
- * Represents symbol in an alphabet.
+ * \brief Represents base for a concrete tree type.
  */
 class TreeBase : public object::ObjectBase {
 public:
-	virtual TreeBase* clone ( ) const & = 0;
-	virtual TreeBase* clone() && = 0;
+	/**
+	 * @copydoc ObjectBase::clone ( ) const &
+	 */
+	virtual TreeBase * clone ( ) const & override = 0;
+
+	/**
+	 * @copydoc ObjectBase::clone ( ) &&
+	 */
+	virtual TreeBase * clone ( ) && override = 0;
 };
 
 } /* namespace tree */
-- 
GitLab