mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: Improved documentation (#13403)

Browse source
This commit is contained in:
Tiago Danin 2018-07-20 14:58:19 -03:00 • committed by Shelley Vohr
parent 2440d03595
commit 1fd6d38a0a
18 changed files with 79 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api/structures/certificate-principal.md
View file

@ -1,8 +1,8 @@
# CertificatePrincipal Object
* `commonName` String - Common Name
* `organizations` String[] - Organization names
* `organizationUnits` String[] - Organization Unit names
* `locality` String - Locality
* `state` String - State or province
* `country` String - Country or region
* `commonName` String - Common Name.
* `organizations` String[] - Organization names.
* `organizationUnits` String[] - Organization Unit names.
* `locality` String - Locality.
* `state` String - State or province.
* `country` String - Country or region.

26
docs/api/structures/gpu-feature-status.md
View file

@ -1,18 +1,18 @@
# GPUFeatureStatus Object
* `2d_canvas` String - Canvas
* `flash_3d` String - Flash
* `flash_stage3d` String - Flash Stage3D
* `flash_stage3d_baseline` String - Flash Stage3D Baseline profile
* `gpu_compositing` String - Compositing
* `multiple_raster_threads` String - Multiple Raster Threads
* `native_gpu_memory_buffers` String - Native GpuMemoryBuffers
* `rasterization` String - Rasterization
* `video_decode` String - Video Decode
* `video_encode` String - Video Encode
* `vpx_decode` String - VPx Video Decode
* `webgl` String - WebGL
* `webgl2` String - WebGL2
* `2d_canvas` String - Canvas.
* `flash_3d` String - Flash.
* `flash_stage3d` String - Flash Stage3D.
* `flash_stage3d_baseline` String - Flash Stage3D Baseline profile.
* `gpu_compositing` String - Compositing.
* `multiple_raster_threads` String - Multiple Raster Threads.
* `native_gpu_memory_buffers` String - Native GpuMemoryBuffers.
* `rasterization` String - Rasterization.
* `video_decode` String - Video Decode.
* `video_encode` String - Video Encode.
* `vpx_decode` String - VPx Video Decode.
* `webgl` String - WebGL.
* `webgl2` String - WebGL2.
Possible values:

4
docs/api/structures/mime-typed-buffer.md
View file

@ -1,4 +1,4 @@
# MimeTypedBuffer Object
* `mimeType` String - The mimeType of the Buffer that you are sending
* `data` Buffer - The actual Buffer content
* `mimeType` String - The mimeType of the Buffer that you are sending.
* `data` Buffer - The actual Buffer content.

8
docs/api/structures/rectangle.md
View file

@ -1,6 +1,6 @@
# Rectangle Object
* `x` Number - The x coordinate of the origin of the rectangle (must be an integer)
* `y` Number - The y coordinate of the origin of the rectangle (must be an integer)
* `width` Number - The width of the rectangle (must be an integer)
* `height` Number - The height of the rectangle (must be an integer)
* `x` Number - The x coordinate of the origin of the rectangle (must be an integer).
* `y` Number - The y coordinate of the origin of the rectangle (must be an integer).
* `width` Number - The width of the rectangle (must be an integer).
* `height` Number - The height of the rectangle (must be an integer).

4
docs/api/structures/scrubber-item.md
View file

@ -1,4 +1,4 @@
# ScrubberItem Object
* `label` String (optional) - The text to appear in this item
* `icon` NativeImage (optional) - The image to appear in this item
* `label` String (optional) - The text to appear in this item.
* `icon` NativeImage (optional) - The image to appear in this item.

6
docs/api/structures/segmented-control-segment.md
View file

@ -1,5 +1,5 @@
# SegmentedControlSegment Object
* `label` String (optional) - The text to appear in this segment
* `icon` NativeImage (optional) - The image to appear in this segment
* `enabled` Boolean (optional) - Whether this segment is selectable. Default: true
* `label` String (optional) - The text to appear in this segment.
* `icon` NativeImage (optional) - The image to appear in this segment.
* `enabled` Boolean (optional) - Whether this segment is selectable. Default: true.

6
docs/api/structures/stream-protocol-response.md
View file

@ -1,5 +1,5 @@
# StreamProtocolResponse Object
* `statusCode` Number - The HTTP response code
* `headers` Object - An object containing the response headers
* `data` ReadableStream - A Node.js readable stream representing the response body
* `statusCode` Number - The HTTP response code.
* `headers` Object - An object containing the response headers.
* `data` ReadableStream - A Node.js readable stream representing the response body.