Browse Source

Update docs for parsing

Samuel Attard 8 years ago
parent
commit
2b05c61ae3

+ 4 - 4
docs/api/structures/bounds.md

@@ -1,6 +1,6 @@
 # Bounds
 
-* `x` Integer
-* `y` Integer
-* `width` Integer
-* `height` Integer
+* `x` Number
+* `y` Number
+* `width` Number
+* `height` Number

+ 2 - 2
docs/api/structures/certificate.md

@@ -4,6 +4,6 @@
 * `issuerName` String - Issuer's Common Name
 * `subjectName` String - Subject's Common Name
 * `serialNumber` String - Hex value represented string
-* `validStart` Integer - Start date of the certificate being valid in seconds
-* `validExpiry` Integer - End date of the certificate being valid in seconds
+* `validStart` Number - Start date of the certificate being valid in seconds
+* `validExpiry` Number - End date of the certificate being valid in seconds
 * `fingerprint` String - Fingerprint of the certificate

+ 8 - 4
docs/api/structures/display.md

@@ -1,14 +1,18 @@
 # Display
 
-* `id` Integer - Unique identifier associated with the display.
-* `rotation` Integer - Can be 0, 90, 180, 270, represents screen rotation in
+* `id` Number - Unique identifier associated with the display.
+* `rotation` Number - Can be 0, 90, 180, 270, represents screen rotation in
   clock-wise degrees.
 * `scaleFactor` Number - Output device's pixel scale factor.
 * `touchSupport` String - Can be `available`, `unavailable`, `unknown`.
-* `bounds` Object
+* `bounds` [Bounds](bounds.md)
 * `size` Object
-* `workArea` Object
+  * `height` Number
+  * `width` Number
+* `workArea` [Bounds](bounds.md)
 * `workAreaSize` Object
+  * `height` Number
+  * `width` Number
 
 The `Display` object represents a physical display connected to the system. A
 fake `Display` may exist on a headless system, or a `Display` may correspond to

+ 1 - 1
docs/api/structures/jump-list-item.md

@@ -22,7 +22,7 @@
   Jump List, which can be an arbitrary resource file that contains an icon
   (e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to
   show the program icon.
-* `iconIndex` Integer - The index of the icon in the resource file. If a
+* `iconIndex` Number - The index of the icon in the resource file. If a
   resource file contains multiple icons this value can be used to specify the
   zero-based index of the icon that should be displayed for this task. If a
   resource file contains only one icon, this property should be set to zero.

+ 6 - 6
docs/api/structures/memory-usage-details.md

@@ -1,8 +1,8 @@
 # MemoryUsageDetails
 
-* `count` Integer
-* `size` Integer
-* `liveSize` Integer
-* `decodedSize` Integer
-* `purgedSize` Integer
-* `purgeableSize` Integer
+* `count` Number
+* `size` Number
+* `liveSize` Number
+* `decodedSize` Number
+* `purgedSize` Number
+* `purgeableSize` Number

+ 1 - 1
docs/api/structures/shortcut-details.md

@@ -9,7 +9,7 @@ is empty.
 * `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
+* `iconIndex` Number (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
 is empty.

+ 1 - 1
docs/api/structures/task.md

@@ -9,6 +9,6 @@
 * `iconPath` String - The absolute path to an icon to be displayed in a
   JumpList, which can be an arbitrary resource file that contains an icon. You
   can usually specify `process.execPath` to show the icon of the program.
-* `iconIndex` Integer - The icon index in the icon file. If an icon file
+* `iconIndex` Number - The icon index in the icon file. If an icon file
   consists of two or more icons, set this value to identify the icon. If an
   icon file consists of one icon, this value is 0.

+ 1 - 1
docs/api/structures/thumbar-button.md

@@ -4,7 +4,7 @@
   toolbar.
 * `click` Function
 * `tooltip` String (optional) - The text of the button's tooltip.
-* `flags` Array (optional) - Control specific states and behaviors of the
+* `flags` String[] (optional) - Control specific states and behaviors of the
   button. By default, it is `['enabled']`.
 
 The `flags` is an array that can include following `String`s: