Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(85)

Unified Diff: webrtc/api/jsepsessiondescription.h

Issue 2680273002: Adding more comments to every header file in api/ subdirectory. (Closed)
Patch Set: Merge with master Created 3 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « webrtc/api/jsepicecandidate.h ('k') | webrtc/api/mediaconstraintsinterface.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: webrtc/api/jsepsessiondescription.h
diff --git a/webrtc/api/jsepsessiondescription.h b/webrtc/api/jsepsessiondescription.h
index 8f2ab5ff57aaa0d95d2214bcfc1b509aecfeae63..b5e1b4f9f2512a1300f9fd2c69aa538249eda585 100644
--- a/webrtc/api/jsepsessiondescription.h
+++ b/webrtc/api/jsepsessiondescription.h
@@ -8,7 +8,8 @@
* be found in the AUTHORS file in the root of the source tree.
*/
-// Implements the SessionDescriptionInterface.
+// TODO(deadbeef): Move this out of api/; it's an implementation detail and
+// shouldn't be used externally.
#ifndef WEBRTC_API_JSEPSESSIONDESCRIPTION_H_
#define WEBRTC_API_JSEPSESSIONDESCRIPTION_H_
@@ -28,15 +29,18 @@ class SessionDescription;
namespace webrtc {
+// Implementation of SessionDescriptionInterface.
class JsepSessionDescription : public SessionDescriptionInterface {
public:
explicit JsepSessionDescription(const std::string& type);
virtual ~JsepSessionDescription();
- // |error| can be NULL if don't care about the failure reason.
+ // |error| may be NULL.
bool Initialize(const std::string& sdp, SdpParseError* error);
// Takes ownership of |description|.
+ // TODO(deadbeef): Make this use an std::unique_ptr<>, so ownership logic is
+ // more clear.
bool Initialize(cricket::SessionDescription* description,
const std::string& session_id,
const std::string& session_version);
@@ -56,7 +60,7 @@ class JsepSessionDescription : public SessionDescriptionInterface {
virtual std::string type() const {
return type_;
}
- // Allow changing the type. Used for testing.
+ // Allows changing the type. Used for testing.
void set_type(const std::string& type) { type_ = type; }
virtual bool AddCandidate(const IceCandidateInterface* candidate);
virtual size_t RemoveCandidates(
« no previous file with comments | « webrtc/api/jsepicecandidate.h ('k') | webrtc/api/mediaconstraintsinterface.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698