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

Put optional label before dash

Browse source
This commit is contained in:
Kevin Sawicki 2016-12-29 14:11:26 -08:00
parent 196cb2dda4
commit afa3bd2143
10 changed files with 48 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/api/structures/cookie.md
View file

@ -2,13 +2,13 @@
* `name` String - The name of the cookie.
* `value` String - The value of the cookie.
* `domain` String - (optional) The domain of the cookie.
* `hostOnly` Boolean - (optional) Whether the cookie is a host-only cookie.
* `path` String - (optional) The path of the cookie.
* `secure` Boolean - (optional) Whether the cookie is marked as secure.
* `httpOnly` Boolean - (optional) Whether the cookie is marked as HTTP only.
* `session` Boolean - (optional) Whether the cookie is a session cookie or a persistent
* `domain` String (optional) - The domain of the cookie.
* `hostOnly` Boolean (optional) - Whether the cookie is a host-only cookie.
* `path` String (optional) - The path of the cookie.
* `secure` Boolean (optional) - Whether the cookie is marked as secure.
* `httpOnly` Boolean (optional) - Whether the cookie is marked as HTTP only.
* `session` Boolean (optional) - Whether the cookie is a session cookie or a persistent
cookie with an expiration date.
* `expirationDate` Double - (optional) The expiration date of the cookie as
* `expirationDate` Double (optional) - The expiration date of the cookie as
the number of seconds since the UNIX epoch. Not provided for session
cookies.

6
docs/api/structures/jump-list-category.md
View file

@ -1,6 +1,6 @@
# JumpListCategory Object
* `type` String - (optional) One of the following:
* `type` String (optional) - One of the following:
* `tasks` - Items in this category will be placed into the standard `Tasks`
category. There can be only one such category, and it will always be
displayed at the bottom of the Jump List.
@ -10,9 +10,9 @@
of the category and its items are set by Windows. Items may be added to
this category indirectly using `app.addRecentDocument(path)`.
* `custom` - Displays tasks or file links, `name` must be set by the app.
* `name` String - (optional) Must be set if `type` is `custom`, otherwise it should be
* `name` String (optional) - Must be set if `type` is `custom`, otherwise it should be
omitted.
* `items` JumpListItem[] - (optional) Array of [`JumpListItem`](jump-list-item.md) objects if `type` is `tasks` or
* `items` JumpListItem[] (optional) - Array of [`JumpListItem`](jump-list-item.md) objects if `type` is `tasks` or
`custom`, otherwise it should be omitted.
**Note:** If a `JumpListCategory` object has neither the `type` nor the `name`

16
docs/api/structures/jump-list-item.md
View file

@ -1,28 +1,28 @@
# JumpListItem Object
* `type` String - (optional) One of the following:
* `type` String (optional) - One of the following:
* `task` - A task will launch an app with specific arguments.
* `separator` - Can be used to separate items in the standard `Tasks`
category.
* `file` - A file link will open a file using the app that created the
Jump List, for this to work the app must be registered as a handler for
the file type (though it doesn't have to be the default handler).
* `path` String - (optional) Path of the file to open, should only be set if `type` is
* `path` String (optional) - Path of the file to open, should only be set if `type` is
`file`.
* `program` String - (optional) Path of the program to execute, usually you should
* `program` String (optional) - Path of the program to execute, usually you should
specify `process.execPath` which opens the current program. Should only be
set if `type` is `task`.
* `args` String - (optional) The command line arguments when `program` is executed. Should
* `args` String (optional) - The command line arguments when `program` is executed. Should
only be set if `type` is `task`.
* `title` String - (optional) The text to be displayed for the item in the Jump List.
* `title` String (optional) - The text to be displayed for the item in the Jump List.
Should only be set if `type` is `task`.
* `description` String - (optional) Description of the task (displayed in a tooltip).
* `description` String (optional) - Description of the task (displayed in a tooltip).
Should only be set if `type` is `task`.
* `iconPath` String - (optional) The absolute path to an icon to be displayed in a
* `iconPath` String (optional) - The absolute path to an icon to be displayed in a
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` Number - (optional) The index of the icon in the resource file. If a
* `iconIndex` Number (optional) - 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.

2
docs/api/structures/thumbar-button.md
View file

@ -4,7 +4,7 @@
toolbar.
* `click` Function
* `tooltip` String (optional) - The text of the button's tooltip.
* `flags` String[] - (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: