Add documentation explaining relationship between ExperimentalCronetEngine and CronetEngine |
|||||
Issue descriptionIt is not clear from the JavaDoc on when to use ExperimentalCronetEngine and when to CronetEngine. We should also explain the relationship between these two classes. There is nothing preventing a consumer from using ExperimentalCronetEngine everywhere, which will defeat the purpose of having a "experimental" prefix. Ideally, we should guide consumers to cast a CronetEngine to an ExperimentalCronetEngine when they want to use hidden features and not construct an ExperimentalCronetEngine from the start. In that way, it is clear from the call sites that the hidden features are "experimental."
,
Feb 14 2017
,
Feb 15 2017
Andrei might also have good ideas for documenting the Experimental Builders as he invented them.
,
Apr 3 2017
Took a stab and redoing the experimental documentation: https://codereview.chromium.org/2794823003
,
Apr 6 2017
The following revision refers to this bug: https://chromium.googlesource.com/chromium/src.git/+/201919d8a8f8351eb79f914d6b88dd0be7cc8821 commit 201919d8a8f8351eb79f914d6b88dd0be7cc8821 Author: pauljensen <pauljensen@chromium.org> Date: Thu Apr 06 00:37:23 2017 [Cronet] Better document Experimental Cronet classes Major gists of documentation chagnes: 1. Most Experimental instances should only be accesssed via casts to drive home the fact that they aren't meant for general use, only experiemtation. 2. Explain that experimental features may become supported or unsupported. BUG= 671623 R=xunjieli,kapishnikov CQ_INCLUDE_TRYBOTS=master.tryserver.chromium.android:android_cronet_tester Review-Url: https://codereview.chromium.org/2794823003 Cr-Commit-Position: refs/heads/master@{#462295} [modify] https://crrev.com/201919d8a8f8351eb79f914d6b88dd0be7cc8821/components/cronet/android/api/src/org/chromium/net/ExperimentalBidirectionalStream.java [modify] https://crrev.com/201919d8a8f8351eb79f914d6b88dd0be7cc8821/components/cronet/android/api/src/org/chromium/net/ExperimentalCronetEngine.java [modify] https://crrev.com/201919d8a8f8351eb79f914d6b88dd0be7cc8821/components/cronet/android/api/src/org/chromium/net/ExperimentalUrlRequest.java
,
Apr 6 2017
|
|||||
►
Sign in to add a comment |
|||||
Comment 1 by kapishnikov@chromium.org
, Dec 6 2016