document regexp iterate

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 */

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);
 };