From 71acf78c64429c6f7876fa04ef1dd21f5d15be89 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Marjam=C3=A4ki?= <danielm77@spray.se>
Date: Sat, 1 Jan 2011 09:26:24 +0100
Subject: [PATCH] Tokenizer: added doxygen comments

---
 lib/tokenize.h | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/lib/tokenize.h b/lib/tokenize.h
index ae1a53fa9..b6edd62e6 100644
--- a/lib/tokenize.h
+++ b/lib/tokenize.h
@@ -125,14 +125,25 @@ public:
 
     const std::vector<std::string> *getFiles() const;
 
+    /** recreate symbol database */
     void fillFunctionList();
+
+    /**
+     * Get function token by function name
+     * @todo better handling of overloaded functions
+     * @todo only scan parent scopes
+     * @param funcname function name
+     */
     const Token *getFunctionTokenByName(const char funcname[]) const;
+
+    /** get tokens */
     const Token *tokens() const;
 
+    /** return filename for given token */
     std::string file(const Token *tok) const;
 
     /**
-     * get error messages
+     * get error messages that the tokenizer generate
      */
     virtual void getErrorMessages(ErrorLogger *errorLogger, const Settings *settings);