add more comments

libmwereader/mwereader.cpp

@@ -4,7 +4,7 @@
 namespace Corpus2{
 
 bool MWEReader::registered = TokenReader::register_path_reader<MWEReader>(
-	"mwereader","token,chunk,sentence"); // TODO more help?
+	"mwereader","inner,mwepath"); // TODO more help?
 
 	MWEReader::MWEReader(const Tagset &tagset, const std::string &filename)
 		: TokenReader(tagset), inner_filename_(filename)
@@ -20,6 +20,7 @@ bool MWEReader::registered = TokenReader::register_path_reader<MWEReader>(
 	Token* MWEReader::get_next_token()
 	{
 		// TODO MWE stuff
+		// get whole sentence -> process it -> return token by token
 		return inner_reader_->get_next_token();
 	}
 
@@ -32,19 +33,20 @@ bool MWEReader::registered = TokenReader::register_path_reader<MWEReader>(
 	boost::shared_ptr<Chunk> MWEReader::get_next_chunk()
 	{
 		// TODO MWE stuff
+		// get whole chunk -> process sentences -> return processed chunk
 		return inner_reader_->get_next_chunk();
 	}
 
 	void MWEReader::set_option(const std::string& option)
 	{
 
-		if(boost::algorithm::starts_with(option, "inner:"))
-		{
+		if(boost::algorithm::starts_with(option, "inner:")) {
 			std::string inner = option.substr(6);
 			inner_reader_ = create_path_reader(inner, this->tagset(),
 											   inner_filename_);
 		}
 
+
 		// TODO MWE stuff
 	}
 

libmwereader/mwereader.h

@@ -16,10 +16,16 @@ public:
 
 	~MWEReader();
 
+	/// retrieves whole sentence, finds MWEs, and return tokens
 	Token* get_next_token();
 
+	/// the prefered mode for this reader
 	Sentence::Ptr get_next_sentence();
 
+	/**
+	  * retrieves chunk with inner reader and then searches for MWEs within
+	  * sentences.
+	  */
 	boost::shared_ptr<Chunk> get_next_chunk();
 
 	void set_option(const std::string& option);