Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(66)

Unified Diff: include/v8.h

Issue 2263303003: [api] Add documentation for PropertyCallbackInfo. (Closed) Base URL: https://chromium.googlesource.com/v8/v8.git@DocSetHandler
Patch Set: Use doxygen style formatting Created 4 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: include/v8.h
diff --git a/include/v8.h b/include/v8.h
index c93ee238585f5a86527532eb6e927ac7906a9ccb..88d71f1f9021c6a7ef35f49b90ea0353787188ef 100644
--- a/include/v8.h
+++ b/include/v8.h
@@ -3236,12 +3236,46 @@ class FunctionCallbackInfo {
template<typename T>
class PropertyCallbackInfo {
public:
+ /**
+ * \return The isolate of the property access.
+ */
V8_INLINE Isolate* GetIsolate() const;
+
+ /**
+ * \return The data set in the configuration, i.e., in
+ * `NamedPropertyHandlerConfiguration` or
+ * `IndexedPropertyHandlerConfiguration.`
+ */
V8_INLINE Local<Value> Data() const;
+
+ /**
+ * \return The receiver, i.e., the object on which the property access was
+ * intercepted.
jochen (gone - plz use gerrit) 2016/08/23 12:43:26 Not sure I understand. so assuming you have x and
Franzi 2016/08/23 13:11:01 Done.
+ * In `x.a`, the receiver is `x`.
+ */
V8_INLINE Local<Object> This() const;
+
+ /**
+ * \return The object that is the target property, i.e., in `x.a`, the
+ * holder is `a`.
jochen (gone - plz use gerrit) 2016/08/23 12:43:26 see above
Franzi 2016/08/23 13:11:01 Done.
+ */
V8_INLINE Local<Object> Holder() const;
+
+ /**
+ * \return The return value of the callback.
+ * Can be used to define the return value by calling Set().
+ * \code
+ * info.GetReturnValue().Set(...)
+ * \endcode
+ */
V8_INLINE ReturnValue<T> GetReturnValue() const;
+
+ /**
+ * \return True, if the intercepted function should
+ * throw if an error occurs. Usually, `true` corresponds to `'use strict.'`
+ */
V8_INLINE bool ShouldThrowOnError() const;
+
// This shouldn't be public, but the arm compiler needs it.
static const int kArgsLength = 7;
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698