From 3b435d8956a94929d2e9b1972085f875e395268f Mon Sep 17 00:00:00 2001
From: Patrick Niklaus <patrick.niklaus@student.kit.edu>
Date: Fri, 10 Apr 2015 15:46:49 +0200
Subject: [PATCH] Add documentation to ScriptingEnvironment

---
 extractor/scripting_environment.hpp | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/extractor/scripting_environment.hpp b/extractor/scripting_environment.hpp
index be05103c8..8722aee8f 100644
--- a/extractor/scripting_environment.hpp
+++ b/extractor/scripting_environment.hpp
@@ -35,6 +35,13 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 struct lua_State;
 
+/**
+ * Creates a lua context and binds osmium way, node and relation objects and
+ * ExtractionWay and ExtractionNode to lua objects.
+ *
+ * Each thread has its own lua state which is implemented with thread specific
+ * storage from TBB.
+ */
 class ScriptingEnvironment
 {
   public: