Use backticks not vertical bars to denote variables in comments for /modules/utility
Bug: webrtc:12338
Change-Id: I8900efa25a5eebcf57ec894108e1212e1d5b8089
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/227098
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#34675}
diff --git a/modules/utility/include/helpers_android.h b/modules/utility/include/helpers_android.h
index a9e8a60..5e8deb9 100644
--- a/modules/utility/include/helpers_android.h
+++ b/modules/utility/include/helpers_android.h
@@ -17,7 +17,7 @@
#include "rtc_base/system/arch.h"
-// Abort the process if |jni| has a Java exception pending.
+// Abort the process if `jni` has a Java exception pending.
// TODO(henrika): merge with CHECK_JNI_EXCEPTION() in jni_helpers.h.
#define CHECK_EXCEPTION(jni) \
RTC_CHECK(!jni->ExceptionCheck()) \
@@ -37,7 +37,7 @@
// Return a |JNIEnv*| usable on this thread or NULL if this thread is detached.
JNIEnv* GetEnv(JavaVM* jvm);
-// Return a |jlong| that will correctly convert back to |ptr|. This is needed
+// Return a `jlong` that will correctly convert back to `ptr`. This is needed
// because the alternative (of silently passing a 32-bit pointer to a vararg
// function expecting a 64-bit param) picks up garbage in the high 32 bits.
jlong PointerTojlong(void* ptr);
diff --git a/modules/utility/include/jvm_android.h b/modules/utility/include/jvm_android.h
index 693ee51..bafb8f2 100644
--- a/modules/utility/include/jvm_android.h
+++ b/modules/utility/include/jvm_android.h
@@ -97,9 +97,9 @@
explicit JNIEnvironment(JNIEnv* jni);
~JNIEnvironment();
- // Registers native methods with the Java class specified by |name|.
+ // Registers native methods with the Java class specified by `name`.
// Note that the class name must be one of the names in the static
- // |loaded_classes| array defined in jvm_android.cc.
+ // `loaded_classes` array defined in jvm_android.cc.
// This method must be called on the construction thread.
std::unique_ptr<NativeRegistration> RegisterNatives(
const char* name,
@@ -138,7 +138,7 @@
// obj = reg->NewObject("<init>", ,);
// }
//
-// // Each User method can now use |reg| and |obj| and call Java functions
+// // Each User method can now use `reg` and `obj` and call Java functions
// // in WebRtcTest.java, e.g. boolean init() {}.
// bool User::Foo() {
// jmethodID id = reg->GetMethodId("init", "()Z");
@@ -168,9 +168,9 @@
// called successfully. Use the AttachCurrentThreadIfNeeded class if needed.
std::unique_ptr<JNIEnvironment> environment();
- // Returns a JavaClass object given class |name|.
+ // Returns a JavaClass object given class `name`.
// Note that the class name must be one of the names in the static
- // |loaded_classes| array defined in jvm_android.cc.
+ // `loaded_classes` array defined in jvm_android.cc.
// This method must be called on the construction thread.
JavaClass GetClass(const char* name);
diff --git a/modules/utility/source/helpers_android.cc b/modules/utility/source/helpers_android.cc
index f4b35a7..9cfee8a 100644
--- a/modules/utility/source/helpers_android.cc
+++ b/modules/utility/source/helpers_android.cc
@@ -32,7 +32,7 @@
return reinterpret_cast<JNIEnv*>(env);
}
-// Return a |jlong| that will correctly convert back to |ptr|. This is needed
+// Return a `jlong` that will correctly convert back to `ptr`. This is needed
// because the alternative (of silently passing a 32-bit pointer to a vararg
// function expecting a 64-bit param) picks up garbage in the high 32 bits.
jlong PointerTojlong(void* ptr) {
diff --git a/modules/utility/source/process_thread_impl.h b/modules/utility/source/process_thread_impl.h
index 5d22e37..e9a26eb 100644
--- a/modules/utility/source/process_thread_impl.h
+++ b/modules/utility/source/process_thread_impl.h
@@ -73,11 +73,11 @@
}
int64_t run_at_ms;
- // DelayedTask owns the |task|, but some delayed tasks must be removed from
+ // DelayedTask owns the `task`, but some delayed tasks must be removed from
// the std::priority_queue, but mustn't be deleted. std::priority_queue does
// not give non-const access to the values, so storing unique_ptr would
// delete the task as soon as it is remove from the priority queue.
- // Thus lifetime of the |task| is managed manually.
+ // Thus lifetime of the `task` is managed manually.
QueuedTask* task;
};
typedef std::list<ModuleCallback> ModuleList;
