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/neteq/neteq.h b/api/neteq/neteq.h
index 81340f1..dbfa071 100644
--- a/api/neteq/neteq.h
+++ b/api/neteq/neteq.h
@@ -183,7 +183,7 @@
SdpAudioFormat sdp_format;
};
- // Creates a new NetEq object, with parameters set in |config|. The |config|
+ // Creates a new NetEq object, with parameters set in `config`. The `config`
// object will only have to be valid for the duration of the call to this
// method.
static NetEq* Create(
@@ -205,15 +205,15 @@
virtual void InsertEmptyPacket(const RTPHeader& rtp_header) = 0;
// Instructs NetEq to deliver 10 ms of audio data. The data is written to
- // |audio_frame|. All data in |audio_frame| is wiped; |data_|, |speech_type_|,
- // |num_channels_|, |sample_rate_hz_|, |samples_per_channel_|, and
- // |vad_activity_| are updated upon success. If an error is returned, some
+ // `audio_frame`. All data in `audio_frame` is wiped; `data_`, `speech_type_`,
+ // `num_channels_`, `sample_rate_hz_`, `samples_per_channel_`, and
+ // `vad_activity_` are updated upon success. If an error is returned, some
// fields may not have been updated, or may contain inconsistent values.
- // If muted state is enabled (through Config::enable_muted_state), |muted|
+ // If muted state is enabled (through Config::enable_muted_state), `muted`
// may be set to true after a prolonged expand period. When this happens, the
- // |data_| in |audio_frame| is not written, but should be interpreted as being
+ // `data_` in `audio_frame` is not written, but should be interpreted as being
// all zeros. For testing purposes, an override can be supplied in the
- // |action_override| argument, which will cause NetEq to take this action
+ // `action_override` argument, which will cause NetEq to take this action
// next, instead of the action it would normally choose. An optional output
// argument for fetching the current sample rate can be provided, which
// will return the same value as last_output_sample_rate_hz() but will avoid
@@ -228,12 +228,12 @@
// Replaces the current set of decoders with the given one.
virtual void SetCodecs(const std::map<int, SdpAudioFormat>& codecs) = 0;
- // Associates |rtp_payload_type| with the given codec, which NetEq will
+ // Associates `rtp_payload_type` with the given codec, which NetEq will
// instantiate when it needs it. Returns true iff successful.
virtual bool RegisterPayloadType(int rtp_payload_type,
const SdpAudioFormat& audio_format) = 0;
- // Removes |rtp_payload_type| from the codec database. Returns 0 on success,
+ // Removes `rtp_payload_type` from the codec database. Returns 0 on success,
// -1 on failure. Removing a payload type that is not registered is ok and
// will not result in an error.
virtual int RemovePayloadType(uint8_t rtp_payload_type) = 0;
@@ -250,12 +250,12 @@
// Sets a maximum delay in milliseconds for packet buffer. The latency will
// not exceed the given value, even required delay (given the channel
// conditions) is higher. Calling this method has the same effect as setting
- // the |max_delay_ms| value in the NetEq::Config struct.
+ // the `max_delay_ms` value in the NetEq::Config struct.
virtual bool SetMaximumDelay(int delay_ms) = 0;
// Sets a base minimum delay in milliseconds for packet buffer. The minimum
- // delay which is set via |SetMinimumDelay| can't be lower than base minimum
- // delay. Calling this method is similar to setting the |min_delay_ms| value
+ // delay which is set via `SetMinimumDelay` can't be lower than base minimum
+ // delay. Calling this method is similar to setting the `min_delay_ms` value
// in the NetEq::Config struct. Returns true if the base minimum is
// successfully applied, otherwise false is returned.
virtual bool SetBaseMinimumDelayMs(int delay_ms) = 0;
@@ -272,7 +272,7 @@
// The packet buffer part of the delay is not updated during DTX/CNG periods.
virtual int FilteredCurrentDelayMs() const = 0;
- // Writes the current network statistics to |stats|. The statistics are reset
+ // Writes the current network statistics to `stats`. The statistics are reset
// after the call.
virtual int NetworkStatistics(NetEqNetworkStatistics* stats) = 0;
diff --git a/api/neteq/neteq_controller.h b/api/neteq/neteq_controller.h
index 4c49a0c..2f203f4 100644
--- a/api/neteq/neteq_controller.h
+++ b/api/neteq/neteq_controller.h
@@ -115,13 +115,13 @@
virtual void SoftReset() = 0;
// Given info about the latest received packet, and current jitter buffer
- // status, returns the operation. |target_timestamp| and |expand_mutefactor|
- // are provided for reference. |last_packet_samples| is the number of samples
+ // status, returns the operation. `target_timestamp` and `expand_mutefactor`
+ // are provided for reference. `last_packet_samples` is the number of samples
// obtained from the last decoded frame. If there is a packet available, it
- // should be supplied in |packet|. The mode resulting from the last call to
- // NetEqImpl::GetAudio is supplied in |last_mode|. If there is a DTMF event to
- // play, |play_dtmf| should be set to true. The output variable
- // |reset_decoder| will be set to true if a reset is required; otherwise it is
+ // should be supplied in `packet`. The mode resulting from the last call to
+ // NetEqImpl::GetAudio is supplied in `last_mode`. If there is a DTMF event to
+ // play, `play_dtmf` should be set to true. The output variable
+ // `reset_decoder` will be set to true if a reset is required; otherwise it is
// left unchanged (i.e., it can remain true if it was true before the call).
virtual NetEq::Operation GetDecision(const NetEqStatus& status,
bool* reset_decoder) = 0;
@@ -144,11 +144,11 @@
virtual bool SetBaseMinimumDelay(int delay_ms) = 0;
virtual int GetBaseMinimumDelay() const = 0;
- // These methods test the |cng_state_| for different conditions.
+ // These methods test the `cng_state_` for different conditions.
virtual bool CngRfc3389On() const = 0;
virtual bool CngOff() const = 0;
- // Resets the |cng_state_| to kCngOff.
+ // Resets the `cng_state_` to kCngOff.
virtual void SetCngOff() = 0;
// Reports back to DecisionLogic whether the decision to do expand remains or
@@ -157,7 +157,7 @@
// sync buffer.
virtual void ExpandDecision(NetEq::Operation operation) = 0;
- // Adds |value| to |sample_memory_|.
+ // Adds `value` to `sample_memory_`.
virtual void AddSampleMemory(int32_t value) = 0;
// Returns the target buffer level in ms.
diff --git a/api/neteq/neteq_controller_factory.h b/api/neteq/neteq_controller_factory.h
index 6478fce..9aba8a2 100644
--- a/api/neteq/neteq_controller_factory.h
+++ b/api/neteq/neteq_controller_factory.h
@@ -23,7 +23,7 @@
public:
virtual ~NetEqControllerFactory() = default;
- // Creates a new NetEqController object, with parameters set in |config|.
+ // Creates a new NetEqController object, with parameters set in `config`.
virtual std::unique_ptr<NetEqController> CreateNetEqController(
const NetEqController::Config& config) const = 0;
};
diff --git a/api/neteq/neteq_factory.h b/api/neteq/neteq_factory.h
index 65cf9eb..526a128 100644
--- a/api/neteq/neteq_factory.h
+++ b/api/neteq/neteq_factory.h
@@ -24,7 +24,7 @@
public:
virtual ~NetEqFactory() = default;
- // Creates a new NetEq object, with parameters set in |config|. The |config|
+ // Creates a new NetEq object, with parameters set in `config`. The `config`
// object will only have to be valid for the duration of the call to this
// method.
virtual std::unique_ptr<NetEq> CreateNetEq(