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/jsep.h b/api/jsep.h
index b56cf1d..3348d7b 100644
--- a/api/jsep.h
+++ b/api/jsep.h
@@ -73,7 +73,7 @@
// Creates a IceCandidateInterface based on SDP string.
// Returns null if the sdp string can't be parsed.
-// |error| may be null.
+// `error` may be null.
RTC_EXPORT IceCandidateInterface* CreateIceCandidate(const std::string& sdp_mid,
int sdp_mline_index,
const std::string& sdp,
@@ -91,7 +91,7 @@
public:
virtual ~IceCandidateCollection() {}
virtual size_t count() const = 0;
- // Returns true if an equivalent |candidate| exist in the collection.
+ // Returns true if an equivalent `candidate` exist in the collection.
virtual bool HasCandidate(const IceCandidateInterface* candidate) const = 0;
virtual const IceCandidateInterface* at(size_t index) const = 0;
};
@@ -158,7 +158,7 @@
virtual SdpType GetType() const;
// kOffer/kPrAnswer/kAnswer
- // TODO(steveanton): Remove this in favor of |GetType| that returns SdpType.
+ // TODO(steveanton): Remove this in favor of `GetType` that returns SdpType.
virtual std::string type() const = 0;
// Adds the specified candidate to the description.
@@ -190,7 +190,7 @@
// Creates a SessionDescriptionInterface based on the SDP string and the type.
// Returns null if the sdp string can't be parsed or the type is unsupported.
-// |error| may be null.
+// `error` may be null.
// TODO(steveanton): This function is deprecated. Please use the functions below
// which take an SdpType enum instead. Remove this once it is no longer used.
RTC_EXPORT SessionDescriptionInterface* CreateSessionDescription(
@@ -200,8 +200,8 @@
// Creates a SessionDescriptionInterface based on the SDP string and the type.
// Returns null if the SDP string cannot be parsed.
-// If using the signature with |error_out|, details of the parsing error may be
-// written to |error_out| if it is not null.
+// If using the signature with `error_out`, details of the parsing error may be
+// written to `error_out` if it is not null.
RTC_EXPORT std::unique_ptr<SessionDescriptionInterface>
CreateSessionDescription(SdpType type, const std::string& sdp);
RTC_EXPORT std::unique_ptr<SessionDescriptionInterface>
@@ -221,7 +221,7 @@
class RTC_EXPORT CreateSessionDescriptionObserver
: public rtc::RefCountInterface {
public:
- // This callback transfers the ownership of the |desc|.
+ // This callback transfers the ownership of the `desc`.
// TODO(deadbeef): Make this take an std::unique_ptr<> to avoid confusion
// around ownership.
virtual void OnSuccess(SessionDescriptionInterface* desc) = 0;