Skip to content

Commit

Permalink
Add Bluetooth class diagram documentation references to README files.
Browse files Browse the repository at this point in the history
Adjust content/README to markdown to enable linking.
Create new README.md files for content and WebKit bluetooth directories.

Review URL: https://codereview.chromium.org/1647013002

Cr-Commit-Position: refs/heads/master@{#372390}
  • Loading branch information
scheib authored and Commit bot committed Jan 29, 2016
1 parent e9e4e90 commit f5e16bc
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 0 deletions.
5 changes: 5 additions & 0 deletions content/README → content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,8 @@ browser.
Developer documentation:
http://www.chromium.org/developers/content-module

Internal Documentation:

* [Bluetooth](browser/bluetooth/README.md)


24 changes: 24 additions & 0 deletions content/browser/bluetooth/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Bluetooth in Content
====================

`content/*/bluetooth` implements [Web Bluetooth][WB] using the
`device/bluetooth` code module.

[WB]: https://webbluetoothcg.github.io/web-bluetooth/

Testing
--------------------------------------------------------------------------------

Bluetooth layout tests in `third_party/WebKit/LayoutTests/bluetooth/` rely on
fake Bluetooth implementation classes constructed in
`content/shell/browser/layout_test/layout_test_bluetooth_adapter_provider`.
These tests span JavaScript binding to the `device/bluetooth` API layer.


Design Documents
--------------------------------------------------------------------------------

See: [Class Diagram of Web Bluetooth through Bluetooth Android][Class]

[Class]: https://sites.google.com/a/chromium.org/dev/developers/design-documents/bluetooth-design-docs/web-bluetooth-through-bluetooth-android-class-diagram

5 changes: 5 additions & 0 deletions device/bluetooth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,8 @@ Thus:
* ... and so on for characteristics and descriptors.

Fake objects are controlled by `bluetooth_test_android.cc`.

See also: [Class Diagram of Web Bluetooth through Bluetooth Android][Class]

[Class]: https://sites.google.com/a/chromium.org/dev/developers/design-documents/bluetooth-design-docs/web-bluetooth-through-bluetooth-android-class-diagram

23 changes: 23 additions & 0 deletions third_party/WebKit/Source/modules/bluetooth/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Web Bluetooth
=============

`Source/modules/bluetooth` implements [Web Bluetooth][WB].

[WB]: https://webbluetoothcg.github.io/web-bluetooth/

Testing
--------------------------------------------------------------------------------

Bluetooth layout tests in `LayoutTests/bluetooth/` rely on
fake Bluetooth implementation classes constructed in
`content/shell/browser/layout_test/layout_test_bluetooth_adapter_provider`.
These tests span JavaScript binding to the `device/bluetooth` API layer.


Design Documents
--------------------------------------------------------------------------------

See: [Class Diagram of Web Bluetooth through Bluetooth Android][Class]

[Class]: https://sites.google.com/a/chromium.org/dev/developers/design-documents/bluetooth-design-docs/web-bluetooth-through-bluetooth-android-class-diagram

0 comments on commit f5e16bc

Please sign in to comment.