Skip to content

Commit 89f4f1d

Browse files
Add use @link Javadoc annotation to ISdl and SCM
1 parent fb48368 commit 89f4f1d

2 files changed

Lines changed: 4 additions & 0 deletions

File tree

base/src/main/java/com/smartdevicelink/proxy/SystemCapabilityManager.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,7 @@ public Object getCapability(final SystemCapabilityType systemCapabilityType, fin
495495
/** Gets the capability object that corresponds to the supplied capability type by calling the listener immediately with the cached value, if available. If not available, the listener will retrieve a new value and return that when the head unit responds.
496496
* @param systemCapabilityType Type of capability desired
497497
* @param scListener callback to execute upon retrieving capability
498+
* @deprecated use {@link #getCapability(SystemCapabilityType, OnSystemCapabilityListener, boolean)} instead.
498499
*/
499500
@Deprecated
500501
public void getCapability(final SystemCapabilityType systemCapabilityType, final OnSystemCapabilityListener scListener) {
@@ -504,6 +505,7 @@ public void getCapability(final SystemCapabilityType systemCapabilityType, final
504505
/** Gets the capability object that corresponds to the supplied capability type by returning the currently cached value immediately if available. Otherwise returns a null object and works in the background to retrieve the capability for the next call
505506
* @param systemCapabilityType Type of capability desired
506507
* @return Desired capability if it is cached in the manager, otherwise returns null
508+
* @deprecated use {@link #getCapability(SystemCapabilityType, OnSystemCapabilityListener, boolean)} instead.
507509
*/
508510
@Deprecated
509511
public Object getCapability(final SystemCapabilityType systemCapabilityType) {

base/src/main/java/com/smartdevicelink/proxy/interfaces/ISdl.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ public interface ISdl {
207207
* Get SystemCapability Object
208208
* @param systemCapabilityType a system capability type that should be retrieved
209209
* @return the system capability provided if available, null if not
210+
* @deprecated use {@link #getCapability(SystemCapabilityType, OnSystemCapabilityListener, boolean)} instead.
210211
*/
211212
@Deprecated
212213
Object getCapability(SystemCapabilityType systemCapabilityType);
@@ -216,6 +217,7 @@ public interface ISdl {
216217
* @param systemCapabilityType a system capability type that should be retrieved
217218
* @param scListener listener that will be called when the system capability is retrieved. If already cached, it
218219
* will be called immediately
220+
* @deprecated use {@link #getCapability(SystemCapabilityType, OnSystemCapabilityListener, boolean)} instead.
219221
*/
220222
@Deprecated
221223
void getCapability(SystemCapabilityType systemCapabilityType, OnSystemCapabilityListener scListener);

0 commit comments

Comments
 (0)