Browse Source

docs: icon and iconIndex have to be set together

Cheng Zhao 8 years ago
parent
commit
eadffc6db8
1 changed files with 3 additions and 2 deletions
  1. 3 2
      docs/api/shell.md

+ 3 - 2
docs/api/shell.md

@@ -65,8 +65,9 @@ Play the beep sound.
     launching from this shortcut. Default is empty.
   * `description` String (optional) - The description of the shortcut. Default
     is empty.
-  * `icon` String (optional) - The path to the icon, can be a DLL or EXE.
-    Default is empty, which uses the target's icon.
+  * `icon` String (optional) - The path to the icon, can be a DLL or EXE. `icon`
+    and `iconIndex` have to be set together. Default is empty, which uses the
+    target's icon.
   * `iconIndex` Integer (optional) - The resource ID of icon when `icon` is a
     DLL or EXE. Default is 0.
   * `appUserModelId` String (optional) - The Application User Model ID. Default