Fix typos in include/*.h inline documentation.
Patch by Nicolas Kaiser <nikai@nikai.net> R=sgjesse@chromium.org BUG=none TEST=none Review URL: http://codereview.chromium.org/7030008 git-svn-id: http://v8.googlecode.com/svn/branches/bleeding_edge@7891 ce2b1a6d-e550-0410-aec6-3dcde31c8c00
This commit is contained in:
mikhail.naganov@gmail.com
parent
fe2074f580
commit
c5ff1f2155
@ -127,7 +127,7 @@ class EXPORT Debug {
|
||||
/**
|
||||
* Get the context active when the debug event happened. Note this is not
|
||||
* the current active context as the JavaScript part of the debugger is
|
||||
* running in it's own context which is entered at this point.
|
||||
* running in its own context which is entered at this point.
|
||||
*/
|
||||
virtual Handle<Context> GetEventContext() const = 0;
|
||||
|
||||
@ -164,12 +164,13 @@ class EXPORT Debug {
|
||||
/**
|
||||
* Get the context active when the debug event happened. Note this is not
|
||||
* the current active context as the JavaScript part of the debugger is
|
||||
* running in it's own context which is entered at this point.
|
||||
* running in its own context which is entered at this point.
|
||||
*/
|
||||
virtual Handle<Context> GetEventContext() const = 0;
|
||||
|
||||
/**
|
||||
* Client data passed with the corresponding callbak whet it was registered.
|
||||
* Client data passed with the corresponding callback when it was
|
||||
* registered.
|
||||
*/
|
||||
virtual Handle<Value> GetCallbackData() const = 0;
|
||||
|
||||
@ -310,7 +311,7 @@ class EXPORT Debug {
|
||||
* get access to information otherwise not available during normal JavaScript
|
||||
* execution e.g. details on stack frames. Receiver of the function call will
|
||||
* be the debugger context global object, however this is a subject to change.
|
||||
* The following example show a JavaScript function which when passed to
|
||||
* The following example shows a JavaScript function which when passed to
|
||||
* v8::Debug::Call will return the current line of JavaScript execution.
|
||||
*
|
||||
* \code
|
||||
@ -352,7 +353,7 @@ class EXPORT Debug {
|
||||
* 2. V8 is suspended on debug breakpoint; in this state V8 is dedicated
|
||||
* to reading and processing debug messages;
|
||||
* 3. V8 is not running at all or has called some long-working C++ function;
|
||||
* by default it means that processing of all debug message will be deferred
|
||||
* by default it means that processing of all debug messages will be deferred
|
||||
* until V8 gets control again; however, embedding application may improve
|
||||
* this by manually calling this method.
|
||||
*
|
||||
@ -376,7 +377,7 @@ class EXPORT Debug {
|
||||
static void ProcessDebugMessages();
|
||||
|
||||
/**
|
||||
* Debugger is running in it's own context which is entered while debugger
|
||||
* Debugger is running in its own context which is entered while debugger
|
||||
* messages are being dispatched. This is an explicit getter for this
|
||||
* debugger context. Note that the content of the debugger context is subject
|
||||
* to change.
|
||||
|
||||
@ -206,7 +206,7 @@ class HeapGraphNode;
|
||||
|
||||
/**
|
||||
* HeapSnapshotEdge represents a directed connection between heap
|
||||
* graph nodes: from retaners to retained nodes.
|
||||
* graph nodes: from retainers to retained nodes.
|
||||
*/
|
||||
class V8EXPORT HeapGraphEdge {
|
||||
public:
|
||||
@ -357,7 +357,7 @@ class V8EXPORT HeapSnapshot {
|
||||
* Prepare a serialized representation of the snapshot. The result
|
||||
* is written into the stream provided in chunks of specified size.
|
||||
* The total length of the serialized snapshot is unknown in
|
||||
* advance, it is can be roughly equal to JS heap size (that means,
|
||||
* advance, it can be roughly equal to JS heap size (that means,
|
||||
* it can be really big - tens of megabytes).
|
||||
*
|
||||
* For the JSON format, heap contents are represented as an object
|
||||
|
||||
34
include/v8.h
34
include/v8.h
@ -159,7 +159,7 @@ typedef void (*WeakReferenceCallback)(Persistent<Value> object,
|
||||
*
|
||||
* It is safe to extract the object stored in the handle by
|
||||
* dereferencing the handle (for instance, to extract the Object* from
|
||||
* an Handle<Object>); the value will still be governed by a handle
|
||||
* a Handle<Object>); the value will still be governed by a handle
|
||||
* behind the scenes and the same rules apply to these values as to
|
||||
* their handles.
|
||||
*/
|
||||
@ -181,7 +181,7 @@ template <class T> class Handle {
|
||||
* constructor allows you to pass handles as arguments by value and
|
||||
* to assign between handles. However, if you try to assign between
|
||||
* incompatible handles, for instance from a Handle<String> to a
|
||||
* Handle<Number> it will cause a compiletime error. Assigning
|
||||
* Handle<Number> it will cause a compile-time error. Assigning
|
||||
* between compatible handles, for instance assigning a
|
||||
* Handle<String> to a variable declared as Handle<Value>, is legal
|
||||
* because String is a subclass of Value.
|
||||
@ -325,7 +325,7 @@ template <class T> class Persistent : public Handle<T> {
|
||||
* handles as arguments by value and to assign between persistent
|
||||
* handles. However, attempting to assign between incompatible
|
||||
* persistent handles, for instance from a Persistent<String> to a
|
||||
* Persistent<Number> will cause a compiletime error. Assigning
|
||||
* Persistent<Number> will cause a compile-time error. Assigning
|
||||
* between compatible persistent handles, for instance assigning a
|
||||
* Persistent<String> to a variable declared as Persistent<Value>,
|
||||
* is allowed as String is a subclass of Value.
|
||||
@ -371,7 +371,7 @@ template <class T> class Persistent : public Handle<T> {
|
||||
/**
|
||||
* Releases the storage cell referenced by this persistent handle.
|
||||
* Does not remove the reference to the cell from any handles.
|
||||
* This handle's reference, and any any other references to the storage
|
||||
* This handle's reference, and any other references to the storage
|
||||
* cell remain and IsEmpty will still return false.
|
||||
*/
|
||||
inline void Dispose();
|
||||
@ -775,7 +775,7 @@ class V8EXPORT StackTrace {
|
||||
Local<Array> AsArray();
|
||||
|
||||
/**
|
||||
* Grab a snapshot of the the current JavaScript execution stack.
|
||||
* Grab a snapshot of the current JavaScript execution stack.
|
||||
*
|
||||
* \param frame_limit The maximum number of stack frames we want to capture.
|
||||
* \param options Enumerates the set of things we will capture for each
|
||||
@ -834,7 +834,7 @@ class V8EXPORT StackFrame {
|
||||
bool IsEval() const;
|
||||
|
||||
/**
|
||||
* Returns whther or not the associated function is called as a
|
||||
* Returns whether or not the associated function is called as a
|
||||
* constructor via "new".
|
||||
*/
|
||||
bool IsConstructor() const;
|
||||
@ -1182,7 +1182,7 @@ class String : public Primitive {
|
||||
* Associate an external string resource with this string by transforming it
|
||||
* in place so that existing references to this string in the JavaScript heap
|
||||
* will use the external string resource. The external string resource's
|
||||
* character contents needs to be equivalent to this string.
|
||||
* character contents need to be equivalent to this string.
|
||||
* Returns true if the string has been changed to be an external string.
|
||||
* The string is not modified if the operation fails. See NewExternal for
|
||||
* information on the lifetime of the resource.
|
||||
@ -1204,7 +1204,7 @@ class String : public Primitive {
|
||||
* Associate an external string resource with this string by transforming it
|
||||
* in place so that existing references to this string in the JavaScript heap
|
||||
* will use the external string resource. The external string resource's
|
||||
* character contents needs to be equivalent to this string.
|
||||
* character contents need to be equivalent to this string.
|
||||
* Returns true if the string has been changed to be an external string.
|
||||
* The string is not modified if the operation fails. See NewExternal for
|
||||
* information on the lifetime of the resource.
|
||||
@ -1540,8 +1540,8 @@ class Object : public Value {
|
||||
V8EXPORT void TurnOnAccessCheck();
|
||||
|
||||
/**
|
||||
* Returns the identity hash for this object. The current implemenation uses
|
||||
* a hidden property on the object to store the identity hash.
|
||||
* Returns the identity hash for this object. The current implementation
|
||||
* uses a hidden property on the object to store the identity hash.
|
||||
*
|
||||
* The return value will never be 0. Also, it is not guaranteed to be
|
||||
* unique.
|
||||
@ -1622,7 +1622,7 @@ class Object : public Value {
|
||||
Handle<Value> argv[]);
|
||||
|
||||
/**
|
||||
* Call an Object as a consturctor if a callback is set by the
|
||||
* Call an Object as a constructor if a callback is set by the
|
||||
* ObjectTemplate::SetCallAsFunctionHandler method.
|
||||
* Note: This method behaves like the Function::NewInstance method.
|
||||
*/
|
||||
@ -2243,7 +2243,7 @@ class V8EXPORT ObjectTemplate : public Template {
|
||||
*
|
||||
* \param getter The callback to invoke when getting a property.
|
||||
* \param setter The callback to invoke when setting a property.
|
||||
* \param query The callback to invoke to check is an object has a property.
|
||||
* \param query The callback to invoke to check if an object has a property.
|
||||
* \param deleter The callback to invoke when deleting a property.
|
||||
* \param enumerator The callback to invoke to enumerate all the indexed
|
||||
* properties of an object.
|
||||
@ -2706,7 +2706,7 @@ class V8EXPORT V8 {
|
||||
* This means that the fatal error handler is called and that V8 is
|
||||
* terminated.
|
||||
*
|
||||
* IgnoreOutOfMemoryException can be used to not treat a
|
||||
* IgnoreOutOfMemoryException can be used to not treat an
|
||||
* out-of-memory situation as a fatal error. This way, the contexts
|
||||
* that did not cause the out of memory problem might be able to
|
||||
* continue execution.
|
||||
@ -2742,7 +2742,7 @@ class V8EXPORT V8 {
|
||||
/**
|
||||
* Adds a message listener.
|
||||
*
|
||||
* The same message listener can be added more than once and it that
|
||||
* The same message listener can be added more than once and in that
|
||||
* case it will be called more than once for each message.
|
||||
*/
|
||||
static bool AddMessageListener(MessageCallback that,
|
||||
@ -3022,7 +3022,7 @@ class V8EXPORT V8 {
|
||||
* The termination is achieved by throwing an exception that is
|
||||
* uncatchable by JavaScript exception handlers. Termination
|
||||
* exceptions act as if they were caught by a C++ TryCatch exception
|
||||
* handlers. If forceful termination is used, any C++ TryCatch
|
||||
* handler. If forceful termination is used, any C++ TryCatch
|
||||
* exception handler that catches an exception should check if that
|
||||
* exception is a termination exception and immediately return if
|
||||
* that is the case. Returning immediately in that case will
|
||||
@ -3426,7 +3426,7 @@ class V8EXPORT Context {
|
||||
* } // Destructor called here
|
||||
* \endcode
|
||||
*
|
||||
* If you wish to stop using V8 in a thread A you can do this by either
|
||||
* If you wish to stop using V8 in a thread A you can do this either
|
||||
* by destroying the v8::Locker object as above or by constructing a
|
||||
* v8::Unlocker object:
|
||||
*
|
||||
@ -3502,7 +3502,7 @@ class V8EXPORT Locker {
|
||||
/**
|
||||
* Start preemption.
|
||||
*
|
||||
* When preemption is started, a timer is fired every n milli seconds
|
||||
* When preemption is started, a timer is fired every n milliseconds
|
||||
* that will switch between multiple threads that are in contention
|
||||
* for the V8 lock.
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user