Skip to content

Commit 0081233

Browse files
committed
add return type (jsdoc)
1 parent 94b0db2 commit 0081233

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

lib/v8.d.ts

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ export default class CSInterface {
469469
/**
470470
* Retrieves information about the host environment in which the extension is currently running.
471471
*
472-
* @return A HostEnvironment object.
472+
* @return {HostEnvironment} A HostEnvironment object.
473473
*/
474474
getHostEnvironment(): HostEnvironment;
475475
/**
@@ -481,7 +481,7 @@ export default class CSInterface {
481481
*
482482
* @param pathType The path-type constant defined in SystemPath ,
483483
*
484-
* @return The platform-specific system path string.
484+
* @return {string} The platform-specific system path string.
485485
*/
486486
getSystemPath(pathType: SystemPath): string;
487487
/**
@@ -497,14 +497,14 @@ export default class CSInterface {
497497
* Retrieves the unique identifier of the application.
498498
* in which the extension is currently running.
499499
*
500-
* @return The unique ID string.
500+
* @return {string} The unique ID string.
501501
*/
502502
getApplicationID(): string;
503503
/**
504504
* Retrieves host capability information for the application
505505
* in which the extension is currently running.
506506
*
507-
* @return A HostCapabilities object.
507+
* @return {HostCapabilities} A HostCapabilities object.
508508
*/
509509
getHostCapabilities(): HostCapabilities;
510510
/**
@@ -556,15 +556,15 @@ export default class CSInterface {
556556
* @param extensionIds Optional, an array of unique identifiers for extensions of interest.
557557
* If omitted, retrieves data for all extensions.
558558
*
559-
* @return Zero or more Extension objects.
559+
* @return {Extension[]} Zero or more Extension objects.
560560
*/
561561
getExtensions(extensionIds?: string[]): Extension[];
562562
/**
563563
* @TODO: create network interface
564564
*
565565
* Retrieves network-related preferences.
566566
*
567-
* @return A JavaScript object containing network preferences.
567+
* @return {Object} A JavaScript object containing network preferences.
568568
*/
569569
getNetworkPreferences(): object;
570570
/**
@@ -581,20 +581,20 @@ export default class CSInterface {
581581
*
582582
* <code><input type="submit" value="" data-locale="key"/></code>
583583
*
584-
* @return An object containing the resource bundle information.
584+
* @return {Object} An object containing the resource bundle information.
585585
*/
586586
initResourceBundle(): object;
587587
/**
588588
* Writes installation information to a file.
589589
*
590-
* @return The file path.
590+
* @return {string} The file path.
591591
*/
592592
dumpInstallationInfo(): string;
593593
/**
594594
* Retrieves version information for the current Operating System,
595595
* See http://www.useragentstring.com/pages/Chrome/ for Chrome navigator.userAgent values.
596596
*
597-
* @return A string containing the OS version, or "unknown Operation System".
597+
* @return {string} A string containing the OS version, or "unknown Operation System".
598598
* If user customizes the User Agent by setting CEF command parameter "--user-agent", only
599599
* "Mac OS X" or "Windows" will be returned.
600600
*/
@@ -611,7 +611,7 @@ export default class CSInterface {
611611
* "file:///C:/log.txt"
612612
* "mailto:test@adobe.com"
613613
*
614-
* @return One of these error codes:\n
614+
* @return {number} One of these error codes:\n
615615
* <ul>
616616
* <li>NO_ERROR - 0</li>
617617
* <li>ERR_UNKNOWN - 1</li>
@@ -625,7 +625,7 @@ export default class CSInterface {
625625
*
626626
* @since 4.2.0
627627
*
628-
* @return extension ID.
628+
* @return {string} extension ID.
629629
*/
630630
getExtensionID(): string;
631631
/**
@@ -635,7 +635,7 @@ export default class CSInterface {
635635
*
636636
* @since 4.2.0
637637
*
638-
* @return One of the following float number.
638+
* @return {number} One of the following float number.
639639
* <ul>
640640
* <li> -1.0 when error occurs </li>
641641
* <li> 1.0 means normal screen </li>
@@ -696,7 +696,7 @@ export default class CSInterface {
696696
* @param enabled True to enable the item, false to disable it (gray it out).
697697
* @param checked True to select the item, false to deselect it.
698698
*
699-
* @return false when the host application does not support this functionality (HostCapabilities.EXTENDED_PANEL_MENU is false).
699+
* @return {boolean} false when the host application does not support this functionality (HostCapabilities.EXTENDED_PANEL_MENU is false).
700700
* Fails silently if menu label is invalid.
701701
*
702702
* @see HostCapabilities.EXTENDED_PANEL_MENU
@@ -818,7 +818,7 @@ export default class CSInterface {
818818
*
819819
* @since 6.0.0
820820
*
821-
* @return true if the extension window is visible; false if the extension window is hidden.
821+
* @return {boolean} true if the extension window is visible; false if the extension window is hidden.
822822
*/
823823
isWindowVisible(): boolean;
824824
/**

0 commit comments

Comments
 (0)