From d1b779191ab341a19b8fca89cfcbaca4e69b9395 Mon Sep 17 00:00:00 2001 From: Tomas Kypta Date: Fri, 22 Mar 2024 09:58:35 +0100 Subject: [PATCH] Improve JSDoc grammar --- .../android/model/rasp/ActiveCallDetection.ts | 10 +++++----- scripts/android/model/rasp/BiometryDetection.ts | 2 +- scripts/android/model/rasp/HttpProxyDetection.ts | 2 +- scripts/android/model/rasp/RepackagingResult.ts | 2 +- www/MalwarelyticsPlugin.d.ts | 16 ++++++++-------- www/MalwarelyticsPlugin.js | 12 ++++++------ www/MalwarelyticsPlugin.module.d.ts | 16 ++++++++-------- 7 files changed, 30 insertions(+), 30 deletions(-) diff --git a/scripts/android/model/rasp/ActiveCallDetection.ts b/scripts/android/model/rasp/ActiveCallDetection.ts index f44d18d..1dc7df7 100644 --- a/scripts/android/model/rasp/ActiveCallDetection.ts +++ b/scripts/android/model/rasp/ActiveCallDetection.ts @@ -8,24 +8,24 @@ interface ActiveCallDetection { enum CallState { /** Idle state: not ringing and no call established. */ IDLE = "IDLE", - /** Device is ringing. An incoming is being signaled. */ + /** Device is ringing. An incoming call is being signaled. */ RINGING = "RINGING", /** In call. A telephony call is established. */ ACTIVE_CALL = "ACTIVE_CALL", /** In communication. An audio/video chat or VoIP call is established. */ ACTIVE_COMMUNNICATION = "ACTIVE_COMMUNNICATION", /** - * Call screening in progress. - * Call is connected and audio is accessible to call screening applications + * Call screening is in progress. + * The call is connected, and audio is accessible to call screening applications, * but other audio use cases are still possible. */ CALL_SCREENING = "CALL_SCREENING", /** - * A telephony call is established and its audio is being redirected to another device. + * A telephony call is established, and its audio is being redirected to another device. */ ACTIVE_CALL_REDIRECT = "ACTIVE_CALL_REDIRECT", /** - * An audio/video chat or VoIP call is established + * An audio/video chat or VoIP call is established, * and its audio is being redirected to another device. */ ACTIVE_COMMUNICATION_REDIRECT = "ACTIVE_COMMUNICATION_REDIRECT", diff --git a/scripts/android/model/rasp/BiometryDetection.ts b/scripts/android/model/rasp/BiometryDetection.ts index 308d68f..03177ca 100644 --- a/scripts/android/model/rasp/BiometryDetection.ts +++ b/scripts/android/model/rasp/BiometryDetection.ts @@ -3,7 +3,7 @@ interface BiometryDetection { /** Status of the biometry config on the device. */ readonly biometricStatus: BiometricStatus; /** - * Status of the biometry config on the device, raw value obtained + * Status of the biometry config on the device, the raw value obtained * from 'androidx.biometric.BiometricManager'. */ readonly androidxLibStatus: number; diff --git a/scripts/android/model/rasp/HttpProxyDetection.ts b/scripts/android/model/rasp/HttpProxyDetection.ts index 38f1b77..545ebec 100644 --- a/scripts/android/model/rasp/HttpProxyDetection.ts +++ b/scripts/android/model/rasp/HttpProxyDetection.ts @@ -5,7 +5,7 @@ interface HttpProxyDetection { /** Whether the proxy data indicate that a proxy is enabled. */ readonly isHttpProxyEnabled: boolean; - /** Whether the HTTP proxy is using auto config with a PAC script. */ + /** Whether the HTTP proxy is using an auto-config with a PAC script. */ readonly isUsingAutoConfig: boolean; /** Host of the proxy server or null if proxy is not enabled. */ readonly host?: string; diff --git a/scripts/android/model/rasp/RepackagingResult.ts b/scripts/android/model/rasp/RepackagingResult.ts index 5477c49..ee1b026 100644 --- a/scripts/android/model/rasp/RepackagingResult.ts +++ b/scripts/android/model/rasp/RepackagingResult.ts @@ -1,4 +1,4 @@ -/** Result type of repackaging detection. */ +/** The result type of repackaging detection. */ enum RepackagingResult { /** The app is repackaged. */ REPACKAGED_APP = "REPACKAGED_APP", diff --git a/www/MalwarelyticsPlugin.d.ts b/www/MalwarelyticsPlugin.d.ts index e077e8c..f1fbcd6 100644 --- a/www/MalwarelyticsPlugin.d.ts +++ b/www/MalwarelyticsPlugin.d.ts @@ -1009,24 +1009,24 @@ interface ActiveCallDetection { declare enum CallState { /** Idle state: not ringing and no call established. */ IDLE = "IDLE", - /** Device is ringing. An incoming is being signaled. */ + /** Device is ringing. An incoming call is being signaled. */ RINGING = "RINGING", /** In call. A telephony call is established. */ ACTIVE_CALL = "ACTIVE_CALL", /** In communication. An audio/video chat or VoIP call is established. */ ACTIVE_COMMUNNICATION = "ACTIVE_COMMUNNICATION", /** - * Call screening in progress. - * Call is connected and audio is accessible to call screening applications + * Call screening is in progress. + * The call is connected, and audio is accessible to call screening applications, * but other audio use cases are still possible. */ CALL_SCREENING = "CALL_SCREENING", /** - * A telephony call is established and its audio is being redirected to another device. + * A telephony call is established, and its audio is being redirected to another device. */ ACTIVE_CALL_REDIRECT = "ACTIVE_CALL_REDIRECT", /** - * An audio/video chat or VoIP call is established + * An audio/video chat or VoIP call is established, * and its audio is being redirected to another device. */ ACTIVE_COMMUNICATION_REDIRECT = "ACTIVE_COMMUNICATION_REDIRECT", @@ -1058,7 +1058,7 @@ interface BiometryDetection { /** Status of the biometry config on the device. */ readonly biometricStatus: BiometricStatus; /** - * Status of the biometry config on the device, raw value obtained + * Status of the biometry config on the device, the raw value obtained * from 'androidx.biometric.BiometricManager'. */ readonly androidxLibStatus: number; @@ -1133,7 +1133,7 @@ declare enum EmulatorDetectionProof { interface HttpProxyDetection { /** Whether the proxy data indicate that a proxy is enabled. */ readonly isHttpProxyEnabled: boolean; - /** Whether the HTTP proxy is using auto config with a PAC script. */ + /** Whether the HTTP proxy is using an auto-config with a PAC script. */ readonly isUsingAutoConfig: boolean; /** Host of the proxy server or null if proxy is not enabled. */ readonly host?: string; @@ -1158,7 +1158,7 @@ declare enum RaspCallbackType { ACTIVE_CALL = "ACTIVE_CALL", APP_PRESENCE = "APP_PRESENCE" } -/** Result type of repackaging detection. */ +/** The result type of repackaging detection. */ declare enum RepackagingResult { /** The app is repackaged. */ REPACKAGED_APP = "REPACKAGED_APP", diff --git a/www/MalwarelyticsPlugin.js b/www/MalwarelyticsPlugin.js index d530c95..d41d801 100644 --- a/www/MalwarelyticsPlugin.js +++ b/www/MalwarelyticsPlugin.js @@ -1107,24 +1107,24 @@ var CallState; (function (CallState) { /** Idle state: not ringing and no call established. */ CallState["IDLE"] = "IDLE"; - /** Device is ringing. An incoming is being signaled. */ + /** Device is ringing. An incoming call is being signaled. */ CallState["RINGING"] = "RINGING"; /** In call. A telephony call is established. */ CallState["ACTIVE_CALL"] = "ACTIVE_CALL"; /** In communication. An audio/video chat or VoIP call is established. */ CallState["ACTIVE_COMMUNNICATION"] = "ACTIVE_COMMUNNICATION"; /** - * Call screening in progress. - * Call is connected and audio is accessible to call screening applications + * Call screening is in progress. + * The call is connected, and audio is accessible to call screening applications, * but other audio use cases are still possible. */ CallState["CALL_SCREENING"] = "CALL_SCREENING"; /** - * A telephony call is established and its audio is being redirected to another device. + * A telephony call is established, and its audio is being redirected to another device. */ CallState["ACTIVE_CALL_REDIRECT"] = "ACTIVE_CALL_REDIRECT"; /** - * An audio/video chat or VoIP call is established + * An audio/video chat or VoIP call is established, * and its audio is being redirected to another device. */ CallState["ACTIVE_COMMUNICATION_REDIRECT"] = "ACTIVE_COMMUNICATION_REDIRECT"; @@ -1196,7 +1196,7 @@ var RaspCallbackType; RaspCallbackType["ACTIVE_CALL"] = "ACTIVE_CALL"; RaspCallbackType["APP_PRESENCE"] = "APP_PRESENCE"; })(RaspCallbackType || (RaspCallbackType = {})); -/** Result type of repackaging detection. */ +/** The result type of repackaging detection. */ var RepackagingResult; (function (RepackagingResult) { /** The app is repackaged. */ diff --git a/www/MalwarelyticsPlugin.module.d.ts b/www/MalwarelyticsPlugin.module.d.ts index 951d438..92342ed 100644 --- a/www/MalwarelyticsPlugin.module.d.ts +++ b/www/MalwarelyticsPlugin.module.d.ts @@ -1009,24 +1009,24 @@ export interface ActiveCallDetection { export declare enum CallState { /** Idle state: not ringing and no call established. */ IDLE = "IDLE", - /** Device is ringing. An incoming is being signaled. */ + /** Device is ringing. An incoming call is being signaled. */ RINGING = "RINGING", /** In call. A telephony call is established. */ ACTIVE_CALL = "ACTIVE_CALL", /** In communication. An audio/video chat or VoIP call is established. */ ACTIVE_COMMUNNICATION = "ACTIVE_COMMUNNICATION", /** - * Call screening in progress. - * Call is connected and audio is accessible to call screening applications + * Call screening is in progress. + * The call is connected, and audio is accessible to call screening applications, * but other audio use cases are still possible. */ CALL_SCREENING = "CALL_SCREENING", /** - * A telephony call is established and its audio is being redirected to another device. + * A telephony call is established, and its audio is being redirected to another device. */ ACTIVE_CALL_REDIRECT = "ACTIVE_CALL_REDIRECT", /** - * An audio/video chat or VoIP call is established + * An audio/video chat or VoIP call is established, * and its audio is being redirected to another device. */ ACTIVE_COMMUNICATION_REDIRECT = "ACTIVE_COMMUNICATION_REDIRECT", @@ -1058,7 +1058,7 @@ export interface BiometryDetection { /** Status of the biometry config on the device. */ readonly biometricStatus: BiometricStatus; /** - * Status of the biometry config on the device, raw value obtained + * Status of the biometry config on the device, the raw value obtained * from 'androidx.biometric.BiometricManager'. */ readonly androidxLibStatus: number; @@ -1133,7 +1133,7 @@ export declare enum EmulatorDetectionProof { export interface HttpProxyDetection { /** Whether the proxy data indicate that a proxy is enabled. */ readonly isHttpProxyEnabled: boolean; - /** Whether the HTTP proxy is using auto config with a PAC script. */ + /** Whether the HTTP proxy is using an auto-config with a PAC script. */ readonly isUsingAutoConfig: boolean; /** Host of the proxy server or null if proxy is not enabled. */ readonly host?: string; @@ -1158,7 +1158,7 @@ export declare enum RaspCallbackType { ACTIVE_CALL = "ACTIVE_CALL", APP_PRESENCE = "APP_PRESENCE" } -/** Result type of repackaging detection. */ +/** The result type of repackaging detection. */ export declare enum RepackagingResult { /** The app is repackaged. */ REPACKAGED_APP = "REPACKAGED_APP",