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

Unified Diff: blimp/client/README.md

Issue 2376573002: Cleanup blimp/client/core code organization. (Closed)
Patch Set: merged origin/master Created 4 years, 3 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: blimp/client/README.md
diff --git a/blimp/client/README.md b/blimp/client/README.md
index 2f9108eaa4445f8efe328cea2fe29f9796578d54..b2f4f7a2f64fcda4141d029e2717f1f5f48e77d1 100644
--- a/blimp/client/README.md
+++ b/blimp/client/README.md
@@ -38,11 +38,12 @@ Each of the sub-directories have their own `BUILD.gn` file, which includes
targets for both C++ and Java.
* `//blimp/client/core/`
- * `android/` All Android-related code, including Java-code, that are for
- the code living directly in `//blimp/client/core`.
* `compositor/` Code related to the Chrome Compositor.
* `contents/` Code related to the contents of a web page.
* `contents/android/` JNI bridges and Java-code for `contents`.
+ * **`context/` Code related to the context (`BlimpClientContext`), which
+ is the core functionality used by all embedders.**
+ * `context/android` JNI bridges and Java-code for `context`.
* `session/` Code related to the session with the engine.
Most code in `core` do not need any Java counterparts unless the embedder is
@@ -56,9 +57,10 @@ and a real one. The default is to use the dummy API, but an embedder can choose
to enable full blimp support by setting the GN arguments `enable_blimp_client`
to `true`.
-Basically only the implementation of BlimpClientContext has been split out into
-two parts (both in C++ and Java), and the choice of which backing implementation
-to be used is selected by the `enable_blimp_client` flag.
+Basically only the implementation of `BlimpClientContext` has been split out
+into two parts (both in C++ and Java), and the choice of which backing
+implementation to be used is selected by the `enable_blimp_client` flag. These
+two implementations live in `//blimp/client/context`.
### The public directory
@@ -98,6 +100,12 @@ code will move together with the usage of the feature itself, such as
The `session` directory is from the old directory organization, and all the
content of this will move over to the `core/session` directory.
+#### The support directory
+
+The `support` directory is a directory providing help to embedders. This
+typically includes a default implementation of an interface from
+`//blimp/client/public` or other helpful tools.
+
#### The test directory
The `test` directory contains tools helpful for testing client code.
@@ -119,7 +127,7 @@ class `Foo`, that lives in `//blimp/client/core/foo/foo.[cc|h]`.
`//blimp/client/core/foo/android/foo_android.[cc|h]`
* Add the JNI-bridge JNI registration to:
- `//blimp/client/core/android/blimp_jni_registrar.cc`
+ `//blimp/client/core/context/android/blimp_jni_registrar.cc`
* Add this to the top of `//blimp/client/core/foo/BUILD.gn`:
@@ -152,7 +160,7 @@ class `Foo`, that lives in `//blimp/client/core/foo/foo.[cc|h]`.
"android/java/src/org/chromium/blimp/core/foo/Foo.java",
]
- jni_package = "blimp/client/core/contents"
+ jni_package = "blimp/client/core/foo"
}
```
@@ -173,3 +181,6 @@ class `Foo`, that lives in `//blimp/client/core/foo/foo.[cc|h]`.
}
}
```
+
+* Add `//blimp/client/core/foo:foo_java` as a dependency in
+ `//blimp/client/core:core_java`.

Powered by Google App Engine
This is Rietveld 408576698