Use backticks not vertical bars to denote variables in comments
Bug: webrtc:12338
Change-Id: I89c8b3a328d04203177522cbdfd9e606fd4bce4c
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/228246
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#34696}
diff --git a/api/ice_transport_factory.h b/api/ice_transport_factory.h
index a9fd04e..2268ea5 100644
--- a/api/ice_transport_factory.h
+++ b/api/ice_transport_factory.h
@@ -35,9 +35,9 @@
// without using a webrtc::PeerConnection.
// The returned object must be accessed and destroyed on the thread that
// created it.
-// |init.port_allocator()| is required and must outlive the created
+// `init.port_allocator()` is required and must outlive the created
// IceTransportInterface object.
-// |init.async_resolver_factory()| and |init.event_log()| are optional, but if
+// `init.async_resolver_factory()` and `init.event_log()` are optional, but if
// provided must outlive the created IceTransportInterface object.
RTC_EXPORT rtc::scoped_refptr<IceTransportInterface> CreateIceTransport(
IceTransportInit);
diff --git a/api/jsep.h b/api/jsep.h
index 3348d7b..d2aa57c 100644
--- a/api/jsep.h
+++ b/api/jsep.h
@@ -166,8 +166,8 @@
// Ownership is not transferred.
//
// Returns false if the session description does not have a media section
- // that corresponds to |candidate.sdp_mid()| or
- // |candidate.sdp_mline_index()|.
+ // that corresponds to `candidate.sdp_mid()` or
+ // `candidate.sdp_mline_index()`.
virtual bool AddCandidate(const IceCandidateInterface* candidate) = 0;
// Removes the candidates from the description, if found.
diff --git a/api/peer_connection_interface.h b/api/peer_connection_interface.h
index b9350ac..a3c420f 100644
--- a/api/peer_connection_interface.h
+++ b/api/peer_connection_interface.h
@@ -1295,8 +1295,8 @@
// This is called when signaling indicates a transceiver will be receiving
// media from the remote endpoint. This is fired during a call to
// SetRemoteDescription. The receiving track can be accessed by:
- // |transceiver->receiver()->track()| and its associated streams by
- // |transceiver->receiver()->streams()|.
+ // `transceiver->receiver()->track()` and its associated streams by
+ // `transceiver->receiver()->streams()`.
// Note: This will only be called if Unified Plan semantics are specified.
// This behavior is specified in section 2.2.8.2.5 of the "Set the
// RTCSessionDescription" algorithm:
diff --git a/api/rtp_packet_info.h b/api/rtp_packet_info.h
index 13d3a39..bc9839f 100644
--- a/api/rtp_packet_info.h
+++ b/api/rtp_packet_info.h
@@ -113,7 +113,7 @@
// capture clock offset defined in the Absolute Capture Time header extension.
absl::optional<int64_t> local_capture_clock_offset_;
- // Local |webrtc::Clock|-based timestamp of when the packet was received.
+ // Local `webrtc::Clock`-based timestamp of when the packet was received.
Timestamp receive_time_;
};
diff --git a/api/rtp_packet_infos.h b/api/rtp_packet_infos.h
index d636464..2ca3174 100644
--- a/api/rtp_packet_infos.h
+++ b/api/rtp_packet_infos.h
@@ -26,8 +26,8 @@
// an audio or video frame. Uses internal reference counting to make it very
// cheap to copy.
//
-// We should ideally just use |std::vector<RtpPacketInfo>| and have it
-// |std::move()|-ed as the per-packet information is transferred from one object
+// We should ideally just use `std::vector<RtpPacketInfo>` and have it
+// `std::move()`-ed as the per-packet information is transferred from one object
// to another. But moving the info, instead of copying it, is not easily done
// for the current video code.
class RTC_EXPORT RtpPacketInfos {
diff --git a/api/set_local_description_observer_interface.h b/api/set_local_description_observer_interface.h
index 90d000c..8e7b625 100644
--- a/api/set_local_description_observer_interface.h
+++ b/api/set_local_description_observer_interface.h
@@ -21,7 +21,7 @@
// the observer to examine the effects of the operation without delay.
class SetLocalDescriptionObserverInterface : public rtc::RefCountInterface {
public:
- // On success, |error.ok()| is true.
+ // On success, `error.ok()` is true.
virtual void OnSetLocalDescriptionComplete(RTCError error) = 0;
};
diff --git a/api/set_remote_description_observer_interface.h b/api/set_remote_description_observer_interface.h
index 1782555..d1c0753 100644
--- a/api/set_remote_description_observer_interface.h
+++ b/api/set_remote_description_observer_interface.h
@@ -22,7 +22,7 @@
// operation.
class SetRemoteDescriptionObserverInterface : public rtc::RefCountInterface {
public:
- // On success, |error.ok()| is true.
+ // On success, `error.ok()` is true.
virtual void OnSetRemoteDescriptionComplete(RTCError error) = 0;
};
diff --git a/api/stats/rtc_stats.h b/api/stats/rtc_stats.h
index 8ad39b4..a5fae52 100644
--- a/api/stats/rtc_stats.h
+++ b/api/stats/rtc_stats.h
@@ -217,7 +217,7 @@
// Interface for `RTCStats` members, which have a name and a value of a type
// defined in a subclass. Only the types listed in `Type` are supported, these
-// are implemented by |RTCStatsMember<T>|. The value of a member may be
+// are implemented by `RTCStatsMember<T>`. The value of a member may be
// undefined, the value can only be read if `is_defined`.
class RTCStatsMemberInterface {
public:
@@ -286,7 +286,7 @@
// Template implementation of `RTCStatsMemberInterface`.
// The supported types are the ones described by
-// |RTCStatsMemberInterface::Type|.
+// `RTCStatsMemberInterface::Type`.
template <typename T>
class RTCStatsMember : public RTCStatsMemberInterface {
public:
diff --git a/api/stats/rtc_stats_report.h b/api/stats/rtc_stats_report.h
index a26db86..2ced422 100644
--- a/api/stats/rtc_stats_report.h
+++ b/api/stats/rtc_stats_report.h
@@ -90,7 +90,7 @@
// Takes ownership of all the stats in `other`, leaving it empty.
void TakeMembersFrom(rtc::scoped_refptr<RTCStatsReport> other);
- // Stats iterators. Stats are ordered lexicographically on |RTCStats::id|.
+ // Stats iterators. Stats are ordered lexicographically on `RTCStats::id`.
ConstIterator begin() const;
ConstIterator end() const;
diff --git a/api/stats/rtcstats_objects.h b/api/stats/rtcstats_objects.h
index b18ef97..8a6327e 100644
--- a/api/stats/rtcstats_objects.h
+++ b/api/stats/rtcstats_objects.h
@@ -57,7 +57,7 @@
static const char* const kFailed;
};
-// |RTCMediaStreamTrackStats::kind| is not an enum in the spec but the only
+// `RTCMediaStreamTrackStats::kind` is not an enum in the spec but the only
// valid values are "audio" and "video".
// https://w3c.github.io/webrtc-stats/#dom-rtcmediastreamtrackstats-kind
struct RTCMediaStreamTrackKind {
diff --git a/api/stats_types.h b/api/stats_types.h
index 6745d14..9a03db3 100644
--- a/api/stats_types.h
+++ b/api/stats_types.h
@@ -232,7 +232,7 @@
kStatsValueNameSrtpCipher,
kStatsValueNameTargetDelayMs,
kStatsValueNameTargetEncBitrate,
- kStatsValueNameTimingFrameInfo, // Result of |TimingFrameInfo::ToString|
+ kStatsValueNameTimingFrameInfo, // Result of `TimingFrameInfo::ToString`
kStatsValueNameTrackId,
kStatsValueNameTransmitBitrate,
kStatsValueNameTransportType,
diff --git a/api/task_queue/task_queue_base.h b/api/task_queue/task_queue_base.h
index 88419ed..d8af6e6 100644
--- a/api/task_queue/task_queue_base.h
+++ b/api/task_queue/task_queue_base.h
@@ -38,7 +38,7 @@
virtual void Delete() = 0;
// Schedules a task to execute. Tasks are executed in FIFO order.
- // If |task->Run()| returns true, task is deleted on the task queue
+ // If `task->Run()` returns true, task is deleted on the task queue
// before next QueuedTask starts executing.
// When a TaskQueue is deleted, pending tasks will not be executed but they
// will be deleted. The deletion of tasks may happen synchronously on the
diff --git a/api/video_codecs/video_encoder.h b/api/video_codecs/video_encoder.h
index 2bdf8d0..3035dd7 100644
--- a/api/video_codecs/video_encoder.h
+++ b/api/video_codecs/video_encoder.h
@@ -287,7 +287,7 @@
// the last InitEncode() call.
double framerate_fps;
// The network bandwidth available for video. This is at least
- // |bitrate.get_sum_bps()|, but may be higher if the application is not
+ // `bitrate.get_sum_bps()`, but may be higher if the application is not
// network constrained.
DataRate bandwidth_allocation;
diff --git a/api/video_codecs/video_encoder_config.h b/api/video_codecs/video_encoder_config.h
index 5440f1f..cfda2ad 100644
--- a/api/video_codecs/video_encoder_config.h
+++ b/api/video_codecs/video_encoder_config.h
@@ -129,7 +129,7 @@
// An implementation should return a std::vector<VideoStream> with the
// wanted VideoStream settings for the given video resolution.
// The size of the vector may not be larger than
- // |encoder_config.number_of_streams|.
+ // `encoder_config.number_of_streams`.
virtual std::vector<VideoStream> CreateEncoderStreams(
int width,
int height,
diff --git a/api/video_codecs/vp8_frame_buffer_controller.h b/api/video_codecs/vp8_frame_buffer_controller.h
index 852008f..fc494f7 100644
--- a/api/video_codecs/vp8_frame_buffer_controller.h
+++ b/api/video_codecs/vp8_frame_buffer_controller.h
@@ -129,7 +129,7 @@
// Called by the encoder before encoding a frame. Returns a set of overrides
// the controller wishes to enact in the encoder's configuration.
// If a value is not overridden, previous overrides are still in effect.
- // However, if |Vp8EncoderConfig::reset_previous_configuration_overrides|
+ // However, if `Vp8EncoderConfig::reset_previous_configuration_overrides`
// is set to `true`, all previous overrides are reset.
virtual Vp8EncoderConfig UpdateConfiguration(size_t stream_index) = 0;
