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/sync_buffer.h b/modules/audio_coding/neteq/sync_buffer.h
index 754716b..7d24730 100644
--- a/modules/audio_coding/neteq/sync_buffer.h
+++ b/modules/audio_coding/neteq/sync_buffer.h
@@ -35,55 +35,55 @@
// Returns the number of samples yet to play out from the buffer.
size_t FutureLength() const;
- // Adds the contents of |append_this| to the back of the SyncBuffer. Removes
+ // Adds the contents of `append_this` to the back of the SyncBuffer. Removes
// the same number of samples from the beginning of the SyncBuffer, to
- // maintain a constant buffer size. The |next_index_| is updated to reflect
+ // maintain a constant buffer size. The `next_index_` is updated to reflect
// the move of the beginning of "future" data.
void PushBack(const AudioMultiVector& append_this) override;
// Like PushBack, but reads the samples channel-interleaved from the input.
void PushBackInterleaved(const rtc::BufferT<int16_t>& append_this);
- // Adds |length| zeros to the beginning of each channel. Removes
+ // Adds `length` zeros to the beginning of each channel. Removes
// the same number of samples from the end of the SyncBuffer, to
- // maintain a constant buffer size. The |next_index_| is updated to reflect
+ // maintain a constant buffer size. The `next_index_` is updated to reflect
// the move of the beginning of "future" data.
// Note that this operation may delete future samples that are waiting to
// be played.
void PushFrontZeros(size_t length);
- // Inserts |length| zeros into each channel at index |position|. The size of
- // the SyncBuffer is kept constant, which means that the last |length|
+ // Inserts `length` zeros into each channel at index `position`. The size of
+ // the SyncBuffer is kept constant, which means that the last `length`
// elements in each channel will be purged.
virtual void InsertZerosAtIndex(size_t length, size_t position);
// Overwrites each channel in this SyncBuffer with values taken from
- // |insert_this|. The values are taken from the beginning of |insert_this| and
- // are inserted starting at |position|. |length| values are written into each
- // channel. The size of the SyncBuffer is kept constant. That is, if |length|
- // and |position| are selected such that the new data would extend beyond the
+ // `insert_this`. The values are taken from the beginning of `insert_this` and
+ // are inserted starting at `position`. `length` values are written into each
+ // channel. The size of the SyncBuffer is kept constant. That is, if `length`
+ // and `position` are selected such that the new data would extend beyond the
// end of the current SyncBuffer, the buffer is not extended.
- // The |next_index_| is not updated.
+ // The `next_index_` is not updated.
virtual void ReplaceAtIndex(const AudioMultiVector& insert_this,
size_t length,
size_t position);
- // Same as the above method, but where all of |insert_this| is written (with
+ // Same as the above method, but where all of `insert_this` is written (with
// the same constraints as above, that the SyncBuffer is not extended).
virtual void ReplaceAtIndex(const AudioMultiVector& insert_this,
size_t position);
- // Reads |requested_len| samples from each channel and writes them interleaved
- // into |output|. The |next_index_| is updated to point to the sample to read
- // next time. The AudioFrame |output| is first reset, and the |data_|,
- // |num_channels_|, and |samples_per_channel_| fields are updated.
+ // Reads `requested_len` samples from each channel and writes them interleaved
+ // into `output`. The `next_index_` is updated to point to the sample to read
+ // next time. The AudioFrame `output` is first reset, and the `data_`,
+ // `num_channels_`, and `samples_per_channel_` fields are updated.
void GetNextAudioInterleaved(size_t requested_len, AudioFrame* output);
- // Adds |increment| to |end_timestamp_|.
+ // Adds `increment` to `end_timestamp_`.
void IncreaseEndTimestamp(uint32_t increment);
// Flushes the buffer. The buffer will contain only zeros after the flush, and
- // |next_index_| will point to the end, like when the buffer was first
+ // `next_index_` will point to the end, like when the buffer was first
// created.
void Flush();