diff --git a/alib2data/src/grammar/Regular/LeftLG.h b/alib2data/src/grammar/Regular/LeftLG.h index 132fc6a314ca050dd98b5c0a00f905ed1ce31e34..376412e75759944d16447f3e2dc294743cb51f5a 100644 --- a/alib2data/src/grammar/Regular/LeftLG.h +++ b/alib2data/src/grammar/Regular/LeftLG.h @@ -217,7 +217,7 @@ public: * * \param symbol new initial symbol of the grammar * - * \returns true of the initial symbol was indeed changed + * \returns true if the initial symbol was indeed changed */ bool setInitialSymbol ( SymbolType symbol ) { return this->template accessElement < InitialSymbol > ( ).set ( std::move ( symbol ) ); @@ -670,6 +670,9 @@ public: /** * Returns true as all terminal symbols are possibly available to be terminal symbols. * + * \param grammar the tested grammar + * \param symbol the tested symbol + * * \returns true */ static bool available ( const grammar::LeftLG < SymbolType > &, const SymbolType & ) { @@ -730,6 +733,9 @@ public: /** * Returns true as all terminal symbols are possibly available to be nonterminal symbols. * + * \param grammar the tested grammar + * \param symbol the tested symbol + * * \returns true */ static bool available ( const grammar::LeftLG < SymbolType > &, const SymbolType & ) { @@ -751,7 +757,7 @@ public: }; /** - * Helper class specifying constraints for the grammar's internal initial symbol component. + * Helper class specifying constraints for the grammar's internal initial symbol element. * * \tparam SymbolType used for the initial symbol of the grammar. */ @@ -772,6 +778,9 @@ public: /** * All symbols are valid as initial symbols. + * + * \param grammar the tested grammar + * \param symbol the tested symbol */ static void valid ( const grammar::LeftLG < SymbolType > &, const SymbolType & ) { } diff --git a/alib2data/src/grammar/Regular/LeftRG.h b/alib2data/src/grammar/Regular/LeftRG.h index f565b014aa67d402c0479a04f8f2aa2bc9f1853b..be5c41ca2b6510345da54fbff68d678700eaf9bb 100644 --- a/alib2data/src/grammar/Regular/LeftRG.h +++ b/alib2data/src/grammar/Regular/LeftRG.h @@ -226,7 +226,7 @@ public: * * \param symbol new initial symbol of the grammar * - * \returns true of the initial symbol was indeed changed + * \returns true if the initial symbol was indeed changed */ bool setInitialSymbol ( SymbolType symbol ) { return this->template accessElement < InitialSymbol > ( ).set ( std::move ( symbol ) ); @@ -708,6 +708,9 @@ public: /** * Returns true as all terminal symbols are possibly available to be terminal symbols. * + * \param grammar the tested grammar + * \param symbol the tested symbol + * * \returns true */ static bool available ( const grammar::LeftRG < SymbolType > &, const SymbolType & ) { @@ -763,6 +766,9 @@ public: /** - * Returns true as all terminal symbols are possibly available to be nonterminal symbols. + * + * \param grammar the tested grammar + * \param symbol the tested symbol * * \returns true */ @@ -785,7 +791,7 @@ public: }; /** - * Helper class specifying constraints for the grammar's internal initial symbol component. + * Helper class specifying constraints for the grammar's internal initial symbol element. * * \tparam SymbolType used for the initial symbol of the grammar. */ @@ -806,6 +812,9 @@ public: /** * All symbols are valid as initial symbols. + * + * \param grammar the tested grammar + * \param symbol the tested symbol */ static void valid ( const grammar::LeftRG < SymbolType > &, const SymbolType & ) { } diff --git a/alib2data/src/grammar/Regular/RightLG.h b/alib2data/src/grammar/Regular/RightLG.h index 9496badbf8deab3eeca7a5136f5e09b4027ac3f3..f0c2ef43c29cecb22ecf70efa7dd3dc389e5c8e8 100644 --- a/alib2data/src/grammar/Regular/RightLG.h +++ b/alib2data/src/grammar/Regular/RightLG.h @@ -217,7 +217,7 @@ public: * * \param symbol new initial symbol of the grammar * - * \returns true of the initial symbol was indeed changed + * \returns true if the initial symbol was indeed changed */ bool setInitialSymbol ( SymbolType symbol ) { return this->template accessElement < InitialSymbol > ( ).set ( std::move ( symbol ) ); @@ -667,6 +667,9 @@ public: /** * Returns true as all terminal symbols are possibly available to be terminal symbols. * + * \param grammar the tested grammar + * \param symbol the tested symbol + * * \returns true */ static bool available ( const grammar::RightLG < SymbolType > &, const SymbolType & ) { @@ -727,6 +730,9 @@ public: /** * Returns true as all terminal symbols are possibly available to be nonterminal symbols. * + * \param grammar the tested grammar + * \param symbol the tested symbol + * * \returns true */ static bool available ( const grammar::RightLG < SymbolType > &, const SymbolType & ) { @@ -748,7 +754,7 @@ public: }; /** - * Helper class specifying constraints for the grammar's internal initial symbol component. + * Helper class specifying constraints for the grammar's internal initial symbol element. * * \tparam SymbolType used for the initial symbol of the grammar. */ @@ -769,6 +775,9 @@ public: /** * All symbols are valid as initial symbols. + * + * \param grammar the tested grammar + * \param symbol the tested symbol */ static void valid ( const grammar::RightLG < SymbolType > &, const SymbolType & ) { } diff --git a/alib2data/src/grammar/Regular/RightRG.h b/alib2data/src/grammar/Regular/RightRG.h index a56ef3353cf35cee7c5c0e236c3c99ddf1ffb4b8..c90c20a5135fe98853f83ac3afa99e979345a50d 100644 --- a/alib2data/src/grammar/Regular/RightRG.h +++ b/alib2data/src/grammar/Regular/RightRG.h @@ -226,7 +226,7 @@ public: * * \param symbol new initial symbol of the grammar * - * \returns true of the initial symbol was indeed changed + * \returns true if the initial symbol was indeed changed */ bool setInitialSymbol ( SymbolType symbol ) { return this->template accessElement < InitialSymbol > ( ).set ( std::move ( symbol ) ); @@ -705,6 +705,9 @@ public: /** * Returns true as all terminal symbols are possibly available to be terminal symbols. * + * \param grammar the tested grammar + * \param symbol the tested symbol + * * \returns true */ static bool available ( const grammar::RightRG < SymbolType > &, const SymbolType & ) { @@ -761,6 +764,9 @@ public: /** * Returns true as all terminal symbols are possibly available to be nonterminal symbols. * + * \param grammar the tested grammar + * \param symbol the tested symbol + * * \returns true */ static bool available ( const grammar::RightRG < SymbolType > &, const SymbolType & ) { @@ -782,7 +788,7 @@ public: }; /** - * Helper class specifying constraints for the grammar's internal initial symbol component. + * Helper class specifying constraints for the grammar's internal initial symbol element. * * \tparam SymbolType used for the initial symbol of the grammar. */ @@ -803,6 +809,9 @@ public: /** * All symbols are valid as initial symbols. + * + * \param grammar the tested grammar + * \param symbol the tested symbol */ static void valid ( const grammar::RightRG < SymbolType > &, const SymbolType & ) { }