diff options
author | Derek Lewis <DerekNonGeneric@inf.is> | 2020-05-20 16:35:59 +0300 |
---|---|---|
committer | Ruben Bridgewater <ruben@bridgewater.de> | 2020-05-23 18:21:20 +0300 |
commit | 9dd7557c7d934931378593aca48bb0ac08b50920 (patch) | |
tree | b45992fa5d06f491e818e5f802cc1796e16beb34 /src/README.md | |
parent | 78eb420fed154b7729283a3d63c99fa9989ffbea (diff) |
doc: normalize C++ code block info strings
Prior to this commit, C++ fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standarize on
the one with the highest frequency in the doc/api/ dir.
Stats:
> 'cpp' => 19,
> 'C++' => 6,
> 'c++' => 3,
PR-URL: https://github.com/nodejs/node/pull/33483
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'src/README.md')
-rw-r--r-- | src/README.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/README.md b/src/README.md index 6d6e33ab275..2604c4aefa3 100644 --- a/src/README.md +++ b/src/README.md @@ -137,7 +137,7 @@ function getFoo(obj) { } ``` -```c++ +```cpp v8::Local<v8::Value> GetFoo(v8::Local<v8::Context> context, v8::Local<v8::Object> obj) { v8::Isolate* isolate = context->GetIsolate(); @@ -168,7 +168,7 @@ See [exception handling][] for more information about the usage of `.To()`, If it is known that a `Local<Value>` refers to a more specific type, it can be cast to that type using `.As<...>()`: -```c++ +```cpp v8::Local<v8::Value> some_value; // CHECK() is a Node.js utilitity that works similar to assert(). CHECK(some_value->IsUint8Array()); @@ -201,7 +201,7 @@ alive even if no other objects refer to them. Weak global handles do not do that, and instead optionally call a callback when the object they refer to is garbage-collected. -```c++ +```cpp v8::Global<v8::Object> reference; void StoreReference(v8::Isolate* isolate, v8::Local<v8::Object> obj) { @@ -329,7 +329,7 @@ The platform can be accessed through `isolate_data->platform()` given an C++ functions exposed to JS follow a specific signature. The following example is from `node_util.cc`: -```c++ +```cpp void ArrayBufferViewHasBuffer(const FunctionCallbackInfo<Value>& args) { CHECK(args[0]->IsArrayBufferView()); args.GetReturnValue().Set(args[0].As<ArrayBufferView>()->HasBuffer()); @@ -351,7 +351,7 @@ floating-point number or a `Local<Value>` to set the return value. Node.js provides various helpers for building JS classes in C++ and/or attaching C++ functions to the exports of a built-in module: -```c++ +```cpp void Initialize(Local<Object> target, Local<Value> unused, Local<Context> context, @@ -409,7 +409,7 @@ constant string, in order to disambiguate it from other classes of this type, and which could e.g. match the binding’s name (in the example above, that would be `cares_wrap`). -```c++ +```cpp // In the HTTP parser source code file: class BindingData : public BaseObject { public: @@ -523,7 +523,7 @@ to perform further calls to APIs that return `Maybe`s. A typical pattern for dealing with APIs that return `Maybe` and `MaybeLocal` is using `.ToLocal()` and `.To()` and returning early in case there is an error: -```c++ +```cpp // This could also return a v8::MaybeLocal<v8::Number>, for example. v8::Maybe<double> SumNumbers(v8::Local<v8::Context> context, v8::Local<v8::Array> array_of_integers) { @@ -692,7 +692,7 @@ A helper for this is the `ASSIGN_OR_RETURN_UNWRAP` macro that returns from the current function if unwrapping fails (typically that means that the `BaseObject` has been deleted earlier). -```c++ +```cpp void Http2Session::Request(const FunctionCallbackInfo<Value>& args) { Http2Session* session; ASSIGN_OR_RETURN_UNWRAP(&session, args.Holder()); @@ -780,7 +780,7 @@ queues once it returns. Before calling `MakeCallback()`, it is typically necessary to enter both a `HandleScope` and a `Context::Scope`. -```c++ +```cpp void StatWatcher::Callback(uv_fs_poll_t* handle, int status, const uv_stat_t* prev, @@ -872,7 +872,7 @@ The `Utf8Value`, `TwoByteValue` (i.e. UTF-16 value) and `BufferValue` inherit from this class and allow accessing the characters in a JavaScript string this way. -```c++ +```cpp static void Chdir(const FunctionCallbackInfo<Value>& args) { Environment* env = Environment::GetCurrent(args); // ... |