Browse Source

Generic doc fixes

Samuel Attard 8 years ago
parent
commit
aa5c778ca2

+ 2 - 0
docs/api/client-request.md

@@ -65,6 +65,8 @@ Returns:
   * `port` Integer
   * `realm` String
 * `callback` Function
+  * `username` String
+  * `password` String
 
 Emitted when an authenticating proxy is asking for user credentials.
 

+ 2 - 2
docs/api/touch-bar-scrubber.md

@@ -9,9 +9,9 @@ Process: [Main](../tutorial/quick-start.md#main-process)
 * `options` Object
   * `items` [ScrubberItem[]](structures/scrubber-item.md) - An array of items to place in this scrubber
   * `select` Function - Called when the user taps an item that was not the last tapped item
-    * `selectedIndex` - The index of the item the user selected
+    * `selectedIndex` Integer - The index of the item the user selected
   * `highlight` Function - Called when the user taps any item
-    * `highlightedIndex` - The index of the item the user touched
+    * `highlightedIndex` Integer - The index of the item the user touched
   * `selectedStyle` String - Selected item style. Defaults to `null`.
   * `overlayStyle` String - Selected overlay item style. Defaults to `null`.
   * `showArrowButtons` Boolean - Defaults to `false`.

+ 1 - 1
docs/api/touch-bar-segmented-control.md

@@ -19,7 +19,7 @@ Process: [Main](../tutorial/quick-start.md#main-process)
   * `segments` [SegmentedControlSegment[]](structures/segmented-control-segment.md) - An array of segments to place in this control
   * `selectedIndex` Integer (Optional) - The index of the currently selected segment, will update automatically with user interaction
   * `change` Function - Called when the user selects a new segment
-    * `selectedIndex` - The index of the segment the user selected
+    * `selectedIndex` Integer - The index of the segment the user selected
 
 ### Instance Properties