Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ee9e4f6b authored by Andrew Solovay's avatar Andrew Solovay
Browse files

docs: Replacing {#link with {@link 

Several java files had the typo {#link (for cross-references to other
Javadocs) instead of the proper {@link format. This was confusing the
new doc publish tool (Mivi) since that's the format used for {# Django
comments #}.

Fixed a couple of links that had other errors (which prevented building
once the {# -> {@ was done) and other typos.

Replaced throughout the frameworks/base project; I'll need a separate CL
for the AndroidX fixes.

Staged to:

go/dac-stage/reference/android/app/Instrumentation.html
go/dac-stage/reference/android/bluetooth/BluetoothAdapter.html
go/dac-stage/reference/android/bluetooth/BluetoothDevice.html
go/dac-stage/reference/android/bluetooth/BluetoothServerSocket.html
go/dac-stage/reference/android/inputmethodservice/InputMethodService.html
go/dac-stage/reference/android/view/KeyCharacterMap.html
go/dac-stage/reference/android/view/KeyEvent.html
go/dac-stage/reference/android/media/AudioManager.html
go/dac-stage/reference/android/net/wifi/WifiConfiguration.html

(Other files were not in the public Javadocs.)

Bug: 111925950
Test: make ds-docs
Exempt-From-Owner-Approval: Docs-only change
Change-Id: Ia06e1fffd814671289a1caebd5962aedc18a28d7
Merged-In: Ia06e1fffd814671289a1caebd5962aedc18a28d7
parent aaecb581

framework/java/android/bluetooth/BluetoothAdapter.java

+2 −2
Original line number Diff line number Diff line
@@ -2797,7 +2797,7 @@ public final class BluetoothAdapter { 
     * socket will be encrypted.

     * <p>Use {@link BluetoothServerSocket#accept} to retrieve incoming connections from a listening

     * {@link BluetoothServerSocket}.

     * <p>The system will assign a dynamic PSM value. This PSM value can be read from the {#link

     * <p>The system will assign a dynamic PSM value. This PSM value can be read from the {@link

     * BluetoothServerSocket#getPsm()} and this value will be released when this server socket is

     * closed, Bluetooth is turned off, or the application exits unexpectedly.

     * <p>The mechanism of disclosing the assigned dynamic PSM value to the initiating peer is
@@ -2847,7 +2847,7 @@ public final class BluetoothAdapter { 
     * <p>Use {@link BluetoothServerSocket#accept} to retrieve incoming connections from a listening

     * {@link BluetoothServerSocket}.

     * <p>The system will assign a dynamic protocol/service multiplexer (PSM) value. This PSM value

     * can be read from the {#link BluetoothServerSocket#getPsm()} and this value will be released

     * can be read from the {@link BluetoothServerSocket#getPsm()} and this value will be released

     * when this server socket is closed, Bluetooth is turned off, or the application exits

     * unexpectedly.

     * <p>The mechanism of disclosing the assigned dynamic PSM value to the initiating peer is

framework/java/android/bluetooth/BluetoothDevice.java

+4 −4
Original line number Diff line number Diff line
@@ -1567,7 +1567,7 @@ public final class BluetoothDevice implements Parcelable { 
     * For example, for Bluetooth 2.1 devices, if any of the devices does not

     * have an input and output capability or just has the ability to

     * display a numeric key, a secure socket connection is not possible.

     * In such a case, use {#link createInsecureRfcommSocket}.

     * In such a case, use {@link createInsecureRfcommSocket}.

     * For more details, refer to the Security Model section 5.2 (vol 3) of

     * Bluetooth Core Specification version 2.1 + EDR.

     * <p>Use {@link BluetoothSocket#connect} to initiate the outgoing
@@ -1601,7 +1601,7 @@ public final class BluetoothDevice implements Parcelable { 
     * For example, for Bluetooth 2.1 devices, if any of the devices does not

     * have an input and output capability or just has the ability to

     * display a numeric key, a secure socket connection is not possible.

     * In such a case, use {#link createInsecureRfcommSocket}.

     * In such a case, use {@link createInsecureRfcommSocket}.

     * For more details, refer to the Security Model section 5.2 (vol 3) of

     * Bluetooth Core Specification version 2.1 + EDR.

     * <p>Use {@link BluetoothSocket#connect} to initiate the outgoing
@@ -1658,7 +1658,7 @@ public final class BluetoothDevice implements Parcelable { 
     * For example, for Bluetooth 2.1 devices, if any of the devices does not

     * have an input and output capability or just has the ability to

     * display a numeric key, a secure socket connection is not possible.

     * In such a case, use {#link createInsecureRfcommSocketToServiceRecord}.

     * In such a case, use {@link #createInsecureRfcommSocketToServiceRecord}.

     * For more details, refer to the Security Model section 5.2 (vol 3) of

     * Bluetooth Core Specification version 2.1 + EDR.

     * <p>Hint: If you are connecting to a Bluetooth serial board then try
@@ -1938,7 +1938,7 @@ public final class BluetoothDevice implements Parcelable { 
     * encrypted.

     * <p> Use this socket if an authenticated socket link is possible. Authentication refers

     * to the authentication of the link key to prevent man-in-the-middle type of attacks. When a

     * secure socket connection is not possible, use {#link createInsecureLeL2capCocSocket(int,

     * secure socket connection is not possible, use {@link createInsecureLeL2capCocSocket(int,

     * int)}.

     *

     * @param transport Bluetooth transport to use, must be {@link #TRANSPORT_LE}

framework/java/android/bluetooth/BluetoothServerSocket.java

+1 −1
Original line number Diff line number Diff line
@@ -201,7 +201,7 @@ public final class BluetoothServerSocket implements Closeable { 
    /**

     * Returns the assigned dynamic protocol/service multiplexer (PSM) value for the listening L2CAP

     * Connection-oriented Channel (CoC) server socket. This server socket must be returned by the

     * {#link BluetoothAdapter.listenUsingL2capCoc(int)} or {#link

     * {@link BluetoothAdapter.listenUsingL2capCoc(int)} or {@link

     * BluetoothAdapter.listenUsingInsecureL2capCoc(int)}. The returned value is undefined if this

     * method is called on non-L2CAP server sockets.

     *