Use backticks not vertical bars to denote variables in comments for /modules/audio_coding
Bug: webrtc:12338
Change-Id: I02613d9fca45d00e2477f334b7a0416e7912e26b
Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/227037
Reviewed-by: Harald Alvestrand <hta@webrtc.org>
Commit-Queue: Artem Titov <titovartem@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#34621}
diff --git a/modules/audio_coding/neteq/packet_buffer.h b/modules/audio_coding/neteq/packet_buffer.h
index cd2adf7..20a0533 100644
--- a/modules/audio_coding/neteq/packet_buffer.h
+++ b/modules/audio_coding/neteq/packet_buffer.h
@@ -45,7 +45,7 @@
};
// Constructor creates a buffer which can hold a maximum of
- // |max_number_of_packets| packets.
+ // `max_number_of_packets` packets.
PacketBuffer(size_t max_number_of_packets, const TickTimer* tick_timer);
// Deletes all packets in the buffer before destroying the buffer.
@@ -63,7 +63,7 @@
// Returns true for an empty buffer.
virtual bool Empty() const;
- // Inserts |packet| into the buffer. The buffer will take over ownership of
+ // Inserts `packet` into the buffer. The buffer will take over ownership of
// the packet object.
// Returns PacketBuffer::kOK on success, PacketBuffer::kFlushed if the buffer
// was flushed due to overfilling.
@@ -93,14 +93,14 @@
int target_level_ms);
// Gets the timestamp for the first packet in the buffer and writes it to the
- // output variable |next_timestamp|.
+ // output variable `next_timestamp`.
// Returns PacketBuffer::kBufferEmpty if the buffer is empty,
// PacketBuffer::kOK otherwise.
virtual int NextTimestamp(uint32_t* next_timestamp) const;
// Gets the timestamp for the first packet in the buffer with a timestamp no
- // lower than the input limit |timestamp|. The result is written to the output
- // variable |next_timestamp|.
+ // lower than the input limit `timestamp`. The result is written to the output
+ // variable `next_timestamp`.
// Returns PacketBuffer::kBufferEmpty if the buffer is empty,
// PacketBuffer::kOK otherwise.
virtual int NextHigherTimestamp(uint32_t timestamp,
@@ -154,11 +154,11 @@
virtual bool ContainsDtxOrCngPacket(
const DecoderDatabase* decoder_database) const;
- // Static method returning true if |timestamp| is older than |timestamp_limit|
- // but less than |horizon_samples| behind |timestamp_limit|. For instance,
+ // Static method returning true if `timestamp` is older than `timestamp_limit`
+ // but less than `horizon_samples` behind `timestamp_limit`. For instance,
// with timestamp_limit = 100 and horizon_samples = 10, a timestamp in the
// range (90, 100) is considered obsolete, and will yield true.
- // Setting |horizon_samples| to 0 is the same as setting it to 2^31, i.e.,
+ // Setting `horizon_samples` to 0 is the same as setting it to 2^31, i.e.,
// half the 32-bit timestamp range.
static bool IsObsoleteTimestamp(uint32_t timestamp,
uint32_t timestamp_limit,