[api] Add documentation for IndexedPropertyCallbacks.

include/v8.h

 // Copyright 2012 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /** \mainpage V8 API Reference Guide
  *
  * V8 is Google's open source JavaScript engine.
  *
  * This set of documents provides reference material generated from the
  * V8 header file, include/v8.h.
@@ skipping 4612 matching lines @@
  *  env->Global()
  *      ->Set(env.local(), v8_str("obj"), templ->GetFunction(env.local())
  *                                             .ToLocalChecked()
  *                                             ->NewInstance(env.local())
  *                                             .ToLocalChecked())
  *      .FromJust();
  *  v8::Local<v8::Value> result = CompileRun("obj.a = 17; obj.a");
  *  CHECK(v8_num(42)->Equals(env.local(), result).FromJust());
  * \endcode
  *
- * See also `ObjectTemplate::SetNamedPropertyHandler`.
+ * See also `ObjectTemplate::SetHandler`.
  */
 typedef void (*GenericNamedPropertyGetterCallback)(
     Local<Name> property, const PropertyCallbackInfo<Value>& info);
 
 /**
  * Interceptor for set requests on an object.
  *
  * Use `info.GetReturnValue()` to indicate whether the request was intercepted
  * or not. If the setter successfully intercepts the request, i.e., if the
  * request should not be further executed, call
  * `info.GetReturnValue().Set(value)`. If the setter
  * did not intercept the request, i.e., if the request should be handled as
  * if no interceptor is present, do not not call `Set()`.
  *
  * \param property The name of the property for which the request was
  * intercepted.
  * \param value The value which the property will have if the request
  * is not intercepted.
  * \param info Information about the intercepted request, such as
  * isolate, receiver, return value, or whether running in `'use strict'` mode.
  * See `PropertyCallbackInfo`.
  *
  * See also
- * `ObjectTemplate::SetNamedPropertyHandler.`
+ * `ObjectTemplate::SetHandler.`
  */
 typedef void (*GenericNamedPropertySetterCallback)(
     Local<Name> property, Local<Value> value,
     const PropertyCallbackInfo<Value>& info);
 
 /**
  * Intercepts all requests that query the attributes of the
  * property, e.g., getOwnPropertyDescriptor(), propertyIsEnumerable(), and
  * defineProperty().
  *
  * Use `info.GetReturnValue().Set(value)` to set the property attributes. The
  * value is an interger encoding a `v8::PropertyAttribute`.
  *
  * \param property The name of the property for which the request was
  * intercepted.
  * \param info Information about the intercepted request, such as
  * isolate, receiver, return value, or whether running in `'use strict'` mode.
  * See `PropertyCallbackInfo`.
  *
  * \note Some functions query the property attributes internally, even though
  * they do not return the attributes. For example, `hasOwnProperty()` can
  * trigger this interceptor depending on the state of the object.
  *
  * See also
- * `ObjectTemplate::SetNamedPropertyHandler.`
+ * `ObjectTemplate::SetHandler.`
  */
 typedef void (*GenericNamedPropertyQueryCallback)(
     Local<Name> property, const PropertyCallbackInfo<Integer>& info);
 
 /**
  * Interceptor for delete requests on an object.
  *
  * Use `info.GetReturnValue()` to indicate whether the request was intercepted
  * or not. If the deleter successfully intercepts the request, i.e., if the
  * request should not be further executed, call
  * `info.GetReturnValue().Set(value)` with a boolean `value`. The `value` is
  * used as the return value of `delete`.
  *
  * \param property The name of the property for which the request was
  * intercepted.
  * \param info Information about the intercepted request, such as
  * isolate, receiver, return value, or whether running in `'use strict'` mode.
  * See `PropertyCallbackInfo`.
  *
  * \note If you need to mimic the behavior of `delete`, i.e., throw in strict
  * mode instead of returning false, use `info.ShouldThrowOnError()` to determine
  * if you are in strict mode.
  *
- * See also `ObjectTemplate::SetNamedPropertyHandler.`
+ * See also `ObjectTemplate::SetHandler.`
  */
 typedef void (*GenericNamedPropertyDeleterCallback)(
     Local<Name> property, const PropertyCallbackInfo<Boolean>& info);
 
 
 /**
  * Returns an array containing the names of the properties the named
  * property getter intercepts.
  */
 typedef void (*GenericNamedPropertyEnumeratorCallback)(
@@ skipping 10 matching lines @@
  * if no interceptor is present, do not not call `Set()`.
  *
  * \param property The name of the property for which the request was
  * intercepted.
  * \param desc The property descriptor which is used to define the
  * property if the request is not intercepted.
  * \param info Information about the intercepted request, such as
  * isolate, receiver, return value, or whether running in `'use strict'` mode.
  * See `PropertyCallbackInfo`.
  *
- * See also `ObjectTemplate::SetNamedPropertyHandler`.
+ * See also `ObjectTemplate::SetHandler`.
  */
 typedef void (*GenericNamedPropertyDefinerCallback)(
     Local<Name> property, const PropertyDescriptor& desc,
     const PropertyCallbackInfo<Value>& info);
 
 /**
  * Interceptor for getOwnPropertyDescriptor requests on an object.
  *
  * Use `info.GetReturnValue().Set()` to set the return value of the
  * intercepted request. The return value must be an object that
  * can be converted to a PropertyDescriptor, e.g., a `v8::value` returned from
  * `v8::Object::getOwnPropertyDescriptor`.
  *
  * \param property The name of the property for which the request was
  * intercepted.
  * \info Information about the intercepted request, such as
  * isolate, receiver, return value, or whether running in `'use strict'` mode.
  * See `PropertyCallbackInfo`.
  *
  * \note If GetOwnPropertyDescriptor is intercepted, it will
  * always return true, i.e., indicate that the property was found.
  *
- * See also `ObjectTemplate::SetNamedPropertyHandler`.
+ * See also `ObjectTemplate::SetHandler`.
  */
 typedef void (*GenericNamedPropertyDescriptorCallback)(
     Local<Name> property, const PropertyCallbackInfo<Value>& info);
 
 /**
- * Returns the value of the property if the getter intercepts the
- * request.  Otherwise, returns an empty handle.
+ * See `v8::GenericNamedPropertyGetterCallback`.
  */
 typedef void (*IndexedPropertyGetterCallback)(
     uint32_t index,
     const PropertyCallbackInfo<Value>& info);
 
-
 /**
- * Returns the value if the setter intercepts the request.
- * Otherwise, returns an empty handle.
+ * See `v8::GenericNamedPropertySetterCallback`.
  */
 typedef void (*IndexedPropertySetterCallback)(
     uint32_t index,
     Local<Value> value,
     const PropertyCallbackInfo<Value>& info);
 
-
 /**
- * Returns a non-empty handle if the interceptor intercepts the request.
- * The result is an integer encoding property attributes.
+ * See `v8::GenericNamedPropertyQueryCallback`.
  */
 typedef void (*IndexedPropertyQueryCallback)(
     uint32_t index,
     const PropertyCallbackInfo<Integer>& info);
 
-
 /**
- * Returns a non-empty handle if the deleter intercepts the request.
- * The return value is true if the property could be deleted and false
- * otherwise.
+ * See `v8::GenericNamedPropertyDeleterCallback`.
  */
 typedef void (*IndexedPropertyDeleterCallback)(
     uint32_t index,
     const PropertyCallbackInfo<Boolean>& info);
 
-
 /**
- * Returns an array containing the indices of the properties the
- * indexed property getter intercepts.
+ * See `v8::GenericNamedPropertyEnumeratorCallback`.
  */
 typedef void (*IndexedPropertyEnumeratorCallback)(
     const PropertyCallbackInfo<Array>& info);
 
+/**
+ * See `v8::GenericNamedPropertyDefinerCallback`.
+ */
 typedef void (*IndexedPropertyDefinerCallback)(
     uint32_t index, const PropertyDescriptor& desc,
     const PropertyCallbackInfo<Value>& info);
 
+/**
+ * See `v8::GenericNamedPropertyDescriptorCallback`.
+ */
 typedef void (*IndexedPropertyDescriptorCallback)(
     uint32_t index, const PropertyCallbackInfo<Value>& info);
 
 /**
  * Access type specification.
  */
 enum AccessType {
   ACCESS_GET,
   ACCESS_SET,
   ACCESS_HAS,
@@ skipping 230 matching lines @@
   // chain, i.e., only call into interceptor for properties that do not exist.
   // Currently only valid for named interceptors.
   kNonMasking = 1 << 1,
   // Will not call into interceptor for symbol lookup.  Only meaningful for
   // named interceptors.
   kOnlyInterceptStrings = 1 << 2,
 };
 
 struct NamedPropertyHandlerConfiguration {
   NamedPropertyHandlerConfiguration(
-      /** Note: getter is required **/
+      /** Note: getter is required */
       GenericNamedPropertyGetterCallback getter = 0,
       GenericNamedPropertySetterCallback setter = 0,
       GenericNamedPropertyQueryCallback query = 0,
       GenericNamedPropertyDeleterCallback deleter = 0,
       GenericNamedPropertyEnumeratorCallback enumerator = 0,
       Local<Value> data = Local<Value>(),
       PropertyHandlerFlags flags = PropertyHandlerFlags::kNone)
       : getter(getter),
         setter(setter),
         query(query),
@@ skipping 30 matching lines @@
   GenericNamedPropertyEnumeratorCallback enumerator;
   GenericNamedPropertyDefinerCallback definer;
   GenericNamedPropertyDescriptorCallback descriptor;
   Local<Value> data;
   PropertyHandlerFlags flags;
 };
 
 
 struct IndexedPropertyHandlerConfiguration {
   IndexedPropertyHandlerConfiguration(
-      /** Note: getter is required **/
+      /** Note: getter is required */
       IndexedPropertyGetterCallback getter = 0,
       IndexedPropertySetterCallback setter = 0,
       IndexedPropertyQueryCallback query = 0,
       IndexedPropertyDeleterCallback deleter = 0,
       IndexedPropertyEnumeratorCallback enumerator = 0,
       Local<Value> data = Local<Value>(),
       PropertyHandlerFlags flags = PropertyHandlerFlags::kNone)
       : getter(getter),
         setter(setter),
         query(query),
@@ skipping 4367 matching lines @@
  */
 
 
 }  // namespace v8
 
 
 #undef TYPE_CHECK
 
 
 #endif  // INCLUDE_V8_H_