From 8be0271da57698698b54ae63a15397f386bf1d42 Mon Sep 17 00:00:00 2001
From: ilor <kailoran@gmail.com>
Date: Thu, 25 Nov 2010 14:46:31 +0100
Subject: [PATCH] tweak some doxy in Parser

---
 libwccl/parser/Parser.cpp | 40 +++++++++++++++++++--------------------
 1 file changed, 20 insertions(+), 20 deletions(-)

diff --git a/libwccl/parser/Parser.cpp b/libwccl/parser/Parser.cpp
index 4d9268d..35b5591 100644
--- a/libwccl/parser/Parser.cpp
+++ b/libwccl/parser/Parser.cpp
@@ -19,10 +19,10 @@ Parser::~Parser()
 
 // ----------------------------------------------------------------------------
 /**
- * @desc Parse string operator writed in std::string. Converts writed operator
- *       to istream and calling parseStringOperator with istream
- * @arg str writed operator
- * @retrun boost::shared_ptr<Wccl::StrSet>
+ * @desc Parse a string operator contained in a std::string. Converts the string
+ *       to a stream and calls parseStringOperator with it
+ * @arg str operator string
+ * @return the parsed operator via a shared pointer
  */
 boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator(
 		const std::string& str) const
@@ -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.
- * @arg istr input stream with writed operator
- * @return boost::shared_ptr<Wccl::Function<Wccl::StrSet> > to created operator
+ * @arg istr input stream with the operator
+ * @return the parsed operator via a shared pointer
  */
 boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator(
 		std::istream& istr) const
@@ -50,10 +50,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::StrSet> > Parser::parseStringOperator(
 
 // ----------------------------------------------------------------------------
 /**
- * @desc Parse predicates writed in std::string. Converts writed predicates
- *       to istream and calling parsePredicate with istream
- * @arg str writed predicate(s)
- * @return boost::shared_ptr<Wccl::Function<Wccl::Bool> > to created predicate
+ * @desc Parse predicates contained in a std::string. Converts the string
+ *       to a stream and callis parsePredicate with it
+ * @arg str operator string
+ * @return the parsed operator via a shared pointer
  */
 boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate(
 		const std::string& str) const
@@ -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
- * @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(
 		std::istream& istr) const
@@ -80,10 +80,10 @@ boost::shared_ptr<ANTLRParserResult<Wccl::Bool> > Parser::parsePredicate(
 
 // ----------------------------------------------------------------------------
 /**
- * @desc Parse sym set operator writed in std::string. Converts writed operator
- *       to istream and calling parseSymSetOperator with istream
- * @arg str writed operator
- * @retrun boost::shared_ptr<Wccl::Function<Wccl::TSet> >
+ * @desc Parse a sym set operator contained in a std::string. Converts the
+ *       string to a stream and calls parseSymSetOperator with it
+ * @arg str operator string
+ * @return the parsed operator via a shared pointer
  */
 boost::shared_ptr<ANTLRParserResult<Wccl::TSet> > Parser::parseSymSetOperator(
 		const std::string& str) const
@@ -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.
- * @arg istr input stream with writed operator
- * @return boost::shared_ptr<Wccl::Function<Wccl::TSet> > to created operator
+ * @arg istr input stream with the operator
+ * @return the parsed operator via a shared pointer
  */
 boost::shared_ptr<ANTLRParserResult<Wccl::TSet> > Parser::parseSymSetOperator(
 		std::istream& istr) const
-- 
GitLab