From 5ea047fe85cc8edc694da6a9f7f6787dfde122d5 Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Mon, 18 Feb 2019 22:35:09 +0100
Subject: [PATCH] document regexp iterate
---
alib2algo/src/regexp/transform/RegExpIterate.cpp | 13 +++++++++++--
alib2algo/src/regexp/transform/RegExpIterate.h | 12 ++++++++++++
2 files changed, 23 insertions(+), 2 deletions(-)
diff --git a/alib2algo/src/regexp/transform/RegExpIterate.cpp b/alib2algo/src/regexp/transform/RegExpIterate.cpp
index 0e17d994fd..c22e877d2f 100644
--- a/alib2algo/src/regexp/transform/RegExpIterate.cpp
+++ b/alib2algo/src/regexp/transform/RegExpIterate.cpp
@@ -10,7 +10,16 @@
namespace regexp {
-auto RegExpIterateFormalRegExpFormalRegExp = registration::AbstractRegister < RegExpIterate, regexp::FormalRegExp < >, const regexp::FormalRegExp < > & > ( RegExpIterate::iterate );
-auto RegExpIterateUnboundedRegExpUnboundedRegExp = registration::AbstractRegister < RegExpIterate, regexp::UnboundedRegExp < >, const regexp::UnboundedRegExp < > & > ( RegExpIterate::iterate );
+auto RegExpIterateFormalRegExpFormalRegExp = registration::AbstractRegister < RegExpIterate, regexp::FormalRegExp < >, const regexp::FormalRegExp < > & > ( RegExpIterate::iterate, "regexp" ).setDocumentation (
+"Implements iteration of regular expression.\n\
+\n\
+@param regexp the regexp to iterate\n\
+@return regexp describing @p regexp *" );
+
+auto RegExpIterateUnboundedRegExpUnboundedRegExp = registration::AbstractRegister < RegExpIterate, regexp::UnboundedRegExp < >, const regexp::UnboundedRegExp < > & > ( RegExpIterate::iterate, "regexp" ).setDocumentation (
+"Implements iteration of regular expression.\n\
+\n\
+@param regexp the regexp to iterate\n\
+@return regexp describing @p regexp *" );
} /* namespace regexp */
diff --git a/alib2algo/src/regexp/transform/RegExpIterate.h b/alib2algo/src/regexp/transform/RegExpIterate.h
index 9947ffc923..81417983dc 100644
--- a/alib2algo/src/regexp/transform/RegExpIterate.h
+++ b/alib2algo/src/regexp/transform/RegExpIterate.h
@@ -33,10 +33,22 @@ public:
*/
template < class SymbolType >
static regexp::FormalRegExp < SymbolType > iterate(const regexp::FormalRegExp < SymbolType > & regexp);
+
+ /**
+ * \override
+ */
template < class SymbolType >
static regexp::FormalRegExpStructure < SymbolType > iterate(const regexp::FormalRegExpStructure < SymbolType > & regexp);
+
+ /**
+ * \override
+ */
template < class SymbolType >
static regexp::UnboundedRegExp < SymbolType > iterate(const regexp::UnboundedRegExp < SymbolType > & regexp);
+
+ /**
+ * \override
+ */
template < class SymbolType >
static regexp::UnboundedRegExpStructure < SymbolType > iterate(const regexp::UnboundedRegExpStructure < SymbolType > & regexp);
};
--
GitLab