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/video_codecs/video_encoder.h b/api/video_codecs/video_encoder.h
index caf0697..8191f47 100644
--- a/api/video_codecs/video_encoder.h
+++ b/api/video_codecs/video_encoder.h
@@ -167,7 +167,7 @@
ScalingSettings scaling_settings;
// The width and height of the incoming video frames should be divisible
- // by |requested_resolution_alignment|. If they are not, the encoder may
+ // by `requested_resolution_alignment`. If they are not, the encoder may
// drop the incoming frame.
// For example: With I420, this value would be a multiple of 2.
// Note that this field is unrelated to any horizontal or vertical stride
@@ -175,12 +175,12 @@
int requested_resolution_alignment;
// Same as above but if true, each simulcast layer should also be divisible
- // by |requested_resolution_alignment|.
- // Note that scale factors |scale_resolution_down_by| may be adjusted so a
+ // by `requested_resolution_alignment`.
+ // Note that scale factors `scale_resolution_down_by` may be adjusted so a
// common multiple is not too large to avoid largely cropped frames and
// possibly with an aspect ratio far from the original.
// Warning: large values of scale_resolution_down_by could be changed
- // considerably, especially if |requested_resolution_alignment| is large.
+ // considerably, especially if `requested_resolution_alignment` is large.
bool apply_alignment_to_all_simulcast_layers;
// If true, encoder supports working with a native handle (e.g. texture
@@ -215,7 +215,7 @@
bool has_internal_source;
// For each spatial layer (simulcast stream or SVC layer), represented as an
- // element in |fps_allocation| a vector indicates how many temporal layers
+ // element in `fps_allocation` a vector indicates how many temporal layers
// the encoder is using for that spatial layer.
// For each spatial/temporal layer pair, the frame rate fraction is given as
// an 8bit unsigned integer where 0 = 0% and 255 = 100%.
@@ -243,8 +243,8 @@
// Recommended bitrate limits for different resolutions.
std::vector<ResolutionBitrateLimits> resolution_bitrate_limits;
- // Obtains the limits from |resolution_bitrate_limits| that best matches the
- // |frame_size_pixels|.
+ // Obtains the limits from `resolution_bitrate_limits` that best matches the
+ // `frame_size_pixels`.
absl::optional<ResolutionBitrateLimits>
GetEncoderBitrateLimitsForResolution(int frame_size_pixels) const;
@@ -279,7 +279,7 @@
VideoBitrateAllocation bitrate;
// Target framerate, in fps. A value <= 0.0 is invalid and should be
// interpreted as framerate target not available. In this case the encoder
- // should fall back to the max framerate specified in |codec_settings| of
+ // should fall back to the max framerate specified in `codec_settings` of
// the last InitEncode() call.
double framerate_fps;
// The network bandwidth available for video. This is at least
@@ -299,15 +299,15 @@
uint32_t timestamp_of_last_received;
// Describes whether the dependencies of the last received frame were
// all decodable.
- // |false| if some dependencies were undecodable, |true| if all dependencies
- // were decodable, and |nullopt| if the dependencies are unknown.
+ // `false` if some dependencies were undecodable, `true` if all dependencies
+ // were decodable, and `nullopt` if the dependencies are unknown.
absl::optional<bool> dependencies_of_last_received_decodable;
// Describes whether the received frame was decodable.
- // |false| if some dependency was undecodable or if some packet belonging
+ // `false` if some dependency was undecodable or if some packet belonging
// to the last received frame was missed.
- // |true| if all dependencies were decodable and all packets belonging
+ // `true` if all dependencies were decodable and all packets belonging
// to the last received frame were received.
- // |nullopt| if no packet belonging to the last frame was missed, but the
+ // `nullopt` if no packet belonging to the last frame was missed, but the
// last packet in the frame was not yet received.
absl::optional<bool> last_received_decodable;
};