Use backticks not vertical bars to denote variables in comments for /api
Bug: webrtc:12338
Change-Id: Ib97b2c3d64dbd895f261ffa76a2e885bd934a87f
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/226940
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#34554}
diff --git a/api/test/time_controller.h b/api/test/time_controller.h
index bd3192d..17aa0db 100644
--- a/api/test/time_controller.h
+++ b/api/test/time_controller.h
@@ -44,7 +44,7 @@
// Creates a process thread.
virtual std::unique_ptr<ProcessThread> CreateProcessThread(
const char* thread_name) = 0;
- // Creates an rtc::Thread instance. If |socket_server| is nullptr, a default
+ // Creates an rtc::Thread instance. If `socket_server` is nullptr, a default
// noop socket server is created.
// Returned thread is not null and started.
virtual std::unique_ptr<rtc::Thread> CreateThread(
@@ -55,12 +55,12 @@
// thread.
virtual rtc::Thread* GetMainThread() = 0;
// Allow task queues and process threads created by this instance to execute
- // for the given |duration|.
+ // for the given `duration`.
virtual void AdvanceTime(TimeDelta duration) = 0;
// Waits until condition() == true, polling condition() in small time
// intervals.
- // Returns true if condition() was evaluated to true before |max_duration|
+ // Returns true if condition() was evaluated to true before `max_duration`
// elapsed and false otherwise.
bool Wait(const std::function<bool()>& condition,
TimeDelta max_duration = TimeDelta::Seconds(5));
@@ -75,17 +75,17 @@
// Gets a clock that tells the alarm clock's notion of time.
virtual Clock* GetClock() = 0;
- // Schedules the alarm to fire at |deadline|.
- // An alarm clock only supports one deadline. Calls to |ScheduleAlarmAt| with
+ // Schedules the alarm to fire at `deadline`.
+ // An alarm clock only supports one deadline. Calls to `ScheduleAlarmAt` with
// an earlier deadline will reset the alarm to fire earlier.Calls to
- // |ScheduleAlarmAt| with a later deadline are ignored. Returns true if the
+ // `ScheduleAlarmAt` with a later deadline are ignored. Returns true if the
// deadline changed, false otherwise.
virtual bool ScheduleAlarmAt(Timestamp deadline) = 0;
// Sets the callback that should be run when the alarm fires.
virtual void SetCallback(std::function<void()> callback) = 0;
- // Waits for |duration| to pass, according to the alarm clock.
+ // Waits for `duration` to pass, according to the alarm clock.
virtual void Sleep(TimeDelta duration) = 0;
};