Skip to content
Snippets Groups Projects
Commit 8be0271d authored by ilor's avatar ilor
Browse files

tweak some doxy in Parser

parent f2c0a611
Branches
No related merge requests found
...@@ -19,10 +19,10 @@ Parser::~Parser() ...@@ -19,10 +19,10 @@ Parser::~Parser()
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/** /**
* @desc Parse string operator writed in std::string. Converts writed operator * @desc Parse a string operator contained in a std::string. Converts the string
* to istream and calling parseStringOperator with istream * to a stream and calls parseStringOperator with it
* @arg str writed operator * @arg str operator string
* @retrun boost::shared_ptr<Wccl::StrSet> * @return the parsed operator via a shared pointer
*/ */
boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator( boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator(
const std::string& str) const const std::string& str) const
...@@ -34,10 +34,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator( ...@@ -34,10 +34,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator(
} }
/** /**
* @desc Parse string operator. Runs parse_string_operator rule * @desc Parse a string operator. Runs parse_string_operator rule
* in the parser grammar. * in the parser grammar.
* @arg istr input stream with writed operator * @arg istr input stream with the operator
* @return boost::shared_ptr<Wccl::Function<Wccl::StrSet> > to created operator * @return the parsed operator via a shared pointer
*/ */
boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator( boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator(
std::istream& istr) const std::istream& istr) const
...@@ -50,10 +50,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator( ...@@ -50,10 +50,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator(
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/** /**
* @desc Parse predicates writed in std::string. Converts writed predicates * @desc Parse predicates contained in a std::string. Converts the string
* to istream and calling parsePredicate with istream * to a stream and callis parsePredicate with it
* @arg str writed predicate(s) * @arg str operator string
* @return boost::shared_ptr<Wccl::Function<Wccl::Bool> > to created predicate * @return the parsed operator via a shared pointer
*/ */
boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate( boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate(
const std::string& str) const const std::string& str) const
...@@ -65,9 +65,9 @@ boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate( ...@@ -65,9 +65,9 @@ boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate(
} }
/** /**
* @desc Parse predicate. Runs parse_predicates rule in the parser grammar. * @desc Parse a predicate. Runs parse_predicates rule in the parser grammar.
* @arg istr input stream with writed predicate * @arg istr input stream with writed predicate
* @return boost::shared_ptr<Wccl::Function<Wccl::Bool> > to created predicate * @return the parsed operator via a shared pointer
*/ */
boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate( boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate(
std::istream& istr) const std::istream& istr) const
...@@ -80,10 +80,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate( ...@@ -80,10 +80,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate(
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/** /**
* @desc Parse sym set operator writed in std::string. Converts writed operator * @desc Parse a sym set operator contained in a std::string. Converts the
* to istream and calling parseSymSetOperator with istream * string to a stream and calls parseSymSetOperator with it
* @arg str writed operator * @arg str operator string
* @retrun boost::shared_ptr<Wccl::Function<Wccl::TSet> > * @return the parsed operator via a shared pointer
*/ */
boost::shared_ptr<ANTLRParserResult<Wccl::TSet> > Parser::parseSymSetOperator( boost::shared_ptr<ANTLRParserResult<Wccl::TSet> > Parser::parseSymSetOperator(
const std::string& str) const const std::string& str) const
...@@ -95,10 +95,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::TSet> > Parser::parseSymSetOperator( ...@@ -95,10 +95,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::TSet> > Parser::parseSymSetOperator(
} }
/** /**
* @desc Parse sym set operator. Runs parse_sym_set_operator rule * @desc Parse a sym set operator. Runs parse_sym_set_operator rule
* in the parser grammar. * in the parser grammar.
* @arg istr input stream with writed operator * @arg istr input stream with the operator
* @return boost::shared_ptr<Wccl::Function<Wccl::TSet> > to created operator * @return the parsed operator via a shared pointer
*/ */
boost::shared_ptr<ANTLRParserResult<Wccl::TSet> > Parser::parseSymSetOperator( boost::shared_ptr<ANTLRParserResult<Wccl::TSet> > Parser::parseSymSetOperator(
std::istream& istr) const std::istream& istr) const
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment