From a3eec8907cf6e69b82814be249e092834a8a0029 Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Wed, 16 Aug 2017 21:42:21 +0200
Subject: [PATCH] fixes in documentation of regular grammars
---
alib2data/src/grammar/Regular/LeftLG.h | 13 +++++++++++--
alib2data/src/grammar/Regular/LeftRG.h | 13 +++++++++++--
alib2data/src/grammar/Regular/RightLG.h | 13 +++++++++++--
alib2data/src/grammar/Regular/RightRG.h | 13 +++++++++++--
4 files changed, 44 insertions(+), 8 deletions(-)
diff --git a/alib2data/src/grammar/Regular/LeftLG.h b/alib2data/src/grammar/Regular/LeftLG.h
index 132fc6a314..376412e757 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 f565b014aa..be5c41ca2b 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 9496badbf8..f0c2ef43c2 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 a56ef3353c..c90c20a513 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 & ) {
}
--
GitLab