Skip to content

Commit

Permalink
Improve JSDoc grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasKypta committed Mar 22, 2024
1 parent 7021793 commit d1b7791
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 30 deletions.
10 changes: 5 additions & 5 deletions scripts/android/model/rasp/ActiveCallDetection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion scripts/android/model/rasp/BiometryDetection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion scripts/android/model/rasp/HttpProxyDetection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion scripts/android/model/rasp/RepackagingResult.ts
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
16 changes: 8 additions & 8 deletions www/MalwarelyticsPlugin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand All @@ -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",
Expand Down
12 changes: 6 additions & 6 deletions www/MalwarelyticsPlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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. */
Expand Down
16 changes: 8 additions & 8 deletions www/MalwarelyticsPlugin.module.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand All @@ -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",
Expand Down

0 comments on commit d1b7791

Please sign in to comment.