Erick Zhao 18a76c6b9d docs: uniformize module API doc format (#28920) ...

This PR ensures that all API modules are present in the README doc,
as there were a couple missing. It also formats all modules to contain
a level-1 heading and a blockquote description.

2021-04-29 09:56:31 +02:00

..

structures

chore: update ts parser for description comment fixes and generic types (#28709)

2021-04-19 11:44:58 -07:00

accelerator.md

docs: minor grammar & spelling fixes (#22851)

2020-03-31 13:06:25 +09:00

app.md

docs: remove api/locales page (#28911)

2021-04-28 13:11:50 -07:00

auto-updater.md

docs: auto update downloading multiple times (#27888)

2021-03-08 10:03:34 +09:00

browser-view.md

docs: uniformize module API doc format (#28920)

2021-04-29 09:56:31 +02:00

browser-window-proxy.md

refactor: use IPC helpers in window-setup (#17948)

2019-07-09 02:43:49 +03:00

browser-window.md

docs: fix unintentional emoji in win.getMediaSourceId description (#28767)

2021-04-22 10:56:25 -07:00

client-request.md

feat: allow setting the Origin header and Sec-Fetch-* headers in net.request() (#26135)

2020-11-17 14:25:41 -08:00

clipboard.md

docs: improve and add examples for clipboard (#20224)

2019-09-18 16:00:43 -07:00

command-line-switches.md

feat: initialize field trials from command line arguments (#28305)

2021-03-26 09:49:00 +09:00

command-line.md

feat: add --enable-api-filtering-logging commandline switch (#20335)

2019-10-04 10:49:09 -07:00

content-tracing.md

docs: fix contentTracing code sample (#26737)

2020-12-01 15:45:45 -08:00

context-bridge.md

docs: update Node global symbols example to use contextBridge (#28245)

2021-03-22 11:01:12 +09:00

cookies.md

docs: fix cookies event documentation for type generation (#28115)

2021-03-11 12:14:16 -08:00

crash-reporter.md

feat: allow omitting submitURL when uploadToServer is false (#28105)

2021-03-18 14:15:19 -07:00

debugger.md

build: update to standard 14 (#24479)

2020-07-09 10:18:49 -07:00

desktop-capturer.md

docs: improve relative link linting and fix broken (#26020)

2020-10-20 10:46:27 +09:00

dialog.md

docs: remove checkbox options in dialog.showMessageBoxSync (#28418)

2021-04-07 00:18:19 -07:00

dock.md

docs: clarify dock.bounce usage (#19894)

2019-08-23 01:16:18 -07:00

download-item.md

docs: add more info about downloadItem.setSavePath api (#25402)

2020-09-23 11:02:05 +09:00

environment-variables.md

docs: add debugging vars to env var doc (#26743)

2020-12-01 15:04:07 -08:00

extensions.md

feat: implement allowFileAccess loadExtension option (#25198)

2021-02-01 14:41:08 -08:00

file-object.md

docs: es6ify 'Breaking Changes' and 'File' API pages (#15507)

2018-12-05 23:14:52 +11:00

frameless-window.md

fix: enable system maximization for frameless windows except if transparent (#28207)

2021-04-06 08:53:59 +09:00

global-shortcut.md

fix: throw when using globalShortcut before ready (#27002)

2020-12-15 11:13:56 -08:00

in-app-purchase.md

feat: enable explicit IAP restoration (#21461)

2019-12-17 07:07:11 -08:00

incoming-message.md

docs: end listener must be placed before data listener (#25568)

2020-10-06 10:27:30 +09:00

ipc-main.md

docs: Update ipcMain.handle() docs in ipc-main.md for error-handling details (#27461)

2021-02-02 21:22:20 +09:00

ipc-renderer.md

docs: update verb tenses for structured clone notes (#27483)

2021-01-26 14:14:44 -08:00

menu-item.md

feat: add APIs to enable/disable spell checker (#26276)

2020-11-11 10:29:18 -05:00

menu.md

docs: uniformize module API doc format (#28920)

2021-04-29 09:56:31 +02:00

message-channel-main.md

docs: uniformize module API doc format (#28920)

2021-04-29 09:56:31 +02:00

message-port-main.md

docs: uniformize module API doc format (#28920)

2021-04-29 09:56:31 +02:00

native-image.md

feat: add nativeImage.createThumbnailFromPath API (#24802)

2020-08-24 09:36:13 -07:00

native-theme.md

chore: cleanup whitespace in docs (#26356)

2020-11-05 14:12:43 -08:00

net-log.md

refactor: ginify session.netLog (#22732)

2020-03-18 16:46:05 -07:00

net.md

feat: add net.online / net.isOnline() (#21004)

2020-10-20 19:55:06 -07:00

notification.md

feat: custom toast xml and failure reporting for notifications (#25401)

2020-09-29 12:20:10 -07:00

power-monitor.md

docs: suspend and resume are available on Linux (#27958)

2021-03-05 10:11:36 +09:00

power-save-blocker.md

chore: update to standard 12

2018-09-14 14:57:01 +10:00

process.md

docs: update Node global symbols example to use contextBridge (#28245)

2021-03-22 11:01:12 +09:00

protocol.md

docs: link ProtocolRequest doc (#25761)

2020-10-05 11:18:18 -04:00

sandbox-option.md

docs: remove references to remote from docs (#25416)

2020-09-14 10:36:54 -07:00

screen.md

docs: coordinate system of badly named method getCursorScreenPoint (#27156)

2021-01-11 12:19:48 +09:00

service-workers.md

feat: support registering MV3 extension service workers (#27562)

2021-02-11 10:58:03 -05:00

session.md

feat: add session.storagePath to get path on disk for session data (#28665)

2021-04-27 09:54:28 -07:00

share-menu.md

docs: uniformize module API doc format (#28920)

2021-04-29 09:56:31 +02:00

shell.md

chore: remove deprecated shell.moveItemToTrash() (#26723)

2020-11-30 23:25:03 +03:00

synopsis.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

system-preferences.md

chore: update ts parser for description comment fixes and generic types (#28709)

2021-04-19 11:44:58 -07:00

touch-bar-button.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-color-picker.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-group.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-label.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-other-items-proxy.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-popover.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-scrubber.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-segmented-control.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-slider.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar-spacer.md

docs: revised version of the quick start guide (#25760)

2020-10-13 13:15:40 -07:00

touch-bar.md

docs: uniformize module API doc format (#28920)

2021-04-29 09:56:31 +02:00

tray.md

docs: uniformize module API doc format (#28920)

2021-04-29 09:56:31 +02:00

web-contents.md

feat: remove BrowserWindow option inheritance (#28550)

2021-04-21 10:55:17 -07:00

web-frame-main.md

feat: add WebFrameMain.visibilityState (#28706)

2021-04-22 12:00:58 -04:00

web-frame.md

docs: Add clarification for Visual Zoom behavior (#28860)

2021-04-28 17:20:47 -04:00

web-request.md

feat: add frame and webContents to webRequest details (#27078)

2021-01-11 12:20:43 +09:00

webview-tag.md

feat: add more info in setWindowOpenHandler details (#28518)

2021-04-13 15:35:27 -04:00

window-open.md

feat: remove BrowserWindow option inheritance (#28550)

2021-04-21 10:55:17 -07:00