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

Unified Diff: components/cronet/android/api/src/org/chromium/net/ExperimentalUrlRequest.java

Issue 2794823003: [Cronet] Better document Experimental Cronet classes (Closed)
Patch Set: transition->moved Created 3 years, 8 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
Index: components/cronet/android/api/src/org/chromium/net/ExperimentalUrlRequest.java
diff --git a/components/cronet/android/api/src/org/chromium/net/ExperimentalUrlRequest.java b/components/cronet/android/api/src/org/chromium/net/ExperimentalUrlRequest.java
index a74a1123491d09b50cd7dae6eff9acb06e87660c..90fd6768a000811f209dab36050ad28fa549e12d 100644
--- a/components/cronet/android/api/src/org/chromium/net/ExperimentalUrlRequest.java
+++ b/components/cronet/android/api/src/org/chromium/net/ExperimentalUrlRequest.java
@@ -6,17 +6,27 @@ package org.chromium.net;
import java.util.concurrent.Executor;
/**
- * {@link UrlRequest} that exposes experimental features. Created using
- * {@link ExperimentalUrlRequest.Builder}. Every instance of {@link UrlRequest} can
- * be casted to an instance of this class.
+ * {@link UrlRequest} that exposes experimental features. To obtain an
+ * instance of this class, cast a {@code UrlRequest} to this type. Every
+ * instance of {@code UrlRequest} can be cast to an instance of this class.
+ * Instances of this class are not meant for general use, but instead only
+ * to access experimental features. Note that experimental features may be
+ * transitioned to supported features (and moved from
+ * {@link ExperimentalUrlRequest} to {@code UrlRequest}) or may be
+ * unsupported, in which case calling them may have no effect.
*
* {@hide since this class exposes experimental features that should be hidden}.
*/
public abstract class ExperimentalUrlRequest extends UrlRequest {
/**
- * Builder for building {@link UrlRequest}. Created by
- * {@link ExperimentalCronetEngine#newUrlRequestBuilder}. A reference to this class
- * can also be obtained through downcasting of {@link UrlRequest.Builder}.
+ * {@link UrlRequest#Builder} that exposes experimental features. To obtain an
+ * instance of this class, cast a {@code UrlRequest.Builder} to this type. Every
+ * instance of {@code UrlRequest.Builder} can be cast to an instance of this class.
+ * Instances of this class are not meant for general use, but instead only
+ * to access experimental features. Note that experimental features may be
+ * transitioned to supported features (and moved from
+ * {@link ExperimentalUrlRequest#Builder} to {@code UrlRequest.Builder}) or may be
+ * unsupported, in which case calling them may have no effect.
*/
public abstract static class Builder extends UrlRequest.Builder {
/**

Powered by Google App Engine
This is Rietveld 408576698