QScript: document/obsolete things that does not work since the move to JSC

Reviewed-by: Kent Hansen

1 files changed, 10 insertions, 0 deletions

diff --git a/src/script/api/qscriptcontext.cpp b/src/script/api/qscriptcontext.cpp
index 3f08e74..1a11100 100644
--- a/src/script/api/qscriptcontext.cpp
+++ b/src/script/api/qscriptcontext.cpp
@@ -323,6 +323,9 @@ QScriptValue QScriptContext::argumentsObject() const
 
   When a function is called as constructor, the thisObject()
   contains the newly constructed object to be initialized.
+
+  \note This function is only guarenteed to work for a context
+  corresponding to native functions.
 */
 bool QScriptContext::isCalledAsConstructor() const
 {
@@ -413,6 +416,9 @@ void QScriptContext::setReturnValue(const QScriptValue &result)
   object provides access to the local variables associated with this
   context.
 
+  \note The activation object might not be available if there is no
+  active QScriptEngineAgent, as it might be optimized.
+
   \sa argument(), argumentsObject()
 */
 
@@ -472,6 +478,10 @@ QScriptValue QScriptContext::activationObject() const
   activation.
 
   If \a activation is not an object, this function does nothing.
+
+  \note For a context corresponding to a JavaScript function, this is only
+  guarenteed to work if there was an QScriptEngineAgent active on the
+  engine while the function was evaluated.
 */
 void QScriptContext::setActivationObject(const QScriptValue &activation)
 {