Changeset 9748 in orxonox.OLD for branches/new_class_id/src/lib/util/executor/executor_lua_state.h

Timestamp:

Sep 16, 2006, 10:09:59 PM (18 years ago)

Author:

bensch

Message:

completely documented Executors

File:

• branches/new_class_id/src/lib/util/executor/executor_lua_state.h (modified) (4 diffs)

branches/new_class_id/src/lib/util/executor/executor_lua_state.h

@@ -1 +1 @@
 /*!
- * @file executor_generic.h
- * Definition of a Generic Executor
+ * @file executor_lua_state.h
+ * Definition of a Executor that takes lua_State* as input.
  */
 
@@ -32 +32 @@
  #undef FUNCTOR_CALL_TYPE
 #endif
+//! Define the Functor call type as lua_State*.
 #define FUNCTOR_CALL_TYPE lua_State*
-
 
 template<typename type> type fromLua(lua_State* state, int index);
@@ -64 +64 @@
     return (fromLua<ToType>(CallValue, index+1));
   }
+  /**
+   * @param state the state to write into
+   * @param value the Value to write there.
+   */
   template <typename FromType>
   static void storeRet(lua_State*& state, FromType value)
@@ -69 +73 @@
     toLua<FromType>(state, value);
   }
+  /** @returns the Null Value of a lua_State*, namely (pointer-type) NULL */
   static lua_State*& defaultValue() { static lua_State* nullState; return nullState; };
 };