Merge pull request #7717 from electron/doc-lists
Add newlines before lists
This commit is contained in:
		
				commit
				
					
						1c7d5df2fe
					
				
			
		
					 7 changed files with 9 additions and 0 deletions
				
			
		| 
						 | 
				
			
			@ -542,6 +542,7 @@ Returns `Boolean` - Whether the call succeeded.
 | 
			
		|||
### `app.getJumpListSettings()` _Windows_
 | 
			
		||||
 | 
			
		||||
Returns `Object`:
 | 
			
		||||
 | 
			
		||||
* `minItems` Integer - The minimum number of items that will be shown in the
 | 
			
		||||
  Jump List (for a more detailed description of this value see the
 | 
			
		||||
  [MSDN docs][JumpListBeginListMSDN]).
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -79,6 +79,7 @@ Writes the `text` into the clipboard in RTF.
 | 
			
		|||
### `clipboard.readBookmark()` _macOS_ _Windows_
 | 
			
		||||
 | 
			
		||||
Returns `Object`:
 | 
			
		||||
 | 
			
		||||
* `title` String
 | 
			
		||||
* `url` String
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -57,6 +57,7 @@ crash reports.
 | 
			
		|||
### `crashReporter.getLastCrashReport()`
 | 
			
		||||
 | 
			
		||||
Returns `Object`:
 | 
			
		||||
 | 
			
		||||
* `date` String
 | 
			
		||||
* `ID` Integer
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -66,6 +67,7 @@ sent or the crash reporter has not been started, `null` is returned.
 | 
			
		|||
### `crashReporter.getUploadedReports()`
 | 
			
		||||
 | 
			
		||||
Returns `Object[]`:
 | 
			
		||||
 | 
			
		||||
* `date` String
 | 
			
		||||
* `ID` Integer
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -84,6 +84,7 @@ limit, whichever is lower for the current process.
 | 
			
		|||
### `process.getProcessMemoryInfo()`
 | 
			
		||||
 | 
			
		||||
Returns `Object`:
 | 
			
		||||
 | 
			
		||||
* `workingSetSize` Integer - The amount of memory currently pinned to actual physical
 | 
			
		||||
  RAM.
 | 
			
		||||
* `peakWorkingSetSize` Integer - The maximum amount of memory that has ever been pinned
 | 
			
		||||
| 
						 | 
				
			
			@ -99,6 +100,7 @@ that all statistics are reported in Kilobytes.
 | 
			
		|||
### `process.getSystemMemoryInfo()`
 | 
			
		||||
 | 
			
		||||
Returns `Object`:
 | 
			
		||||
 | 
			
		||||
* `total` Integer - The total amount of physical memory in Kilobytes available to the
 | 
			
		||||
  system.
 | 
			
		||||
* `free` Integer - The total amount of memory not being used by applications or disk
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -90,6 +90,7 @@ The `screen` module has the following methods:
 | 
			
		|||
### `screen.getCursorScreenPoint()`
 | 
			
		||||
 | 
			
		||||
Returns `Object`:
 | 
			
		||||
 | 
			
		||||
* `x` Integer
 | 
			
		||||
* `y` Integer
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -124,6 +124,7 @@ this limitation.
 | 
			
		|||
### `webFrame.getResourceUsage()`
 | 
			
		||||
 | 
			
		||||
Returns `Object`:
 | 
			
		||||
 | 
			
		||||
* `images` [MemoryUsageDetails](structures/memory-usage-details.md)
 | 
			
		||||
* `cssStyleSheets` [MemoryUsageDetails](structures/memory-usage-details.md)
 | 
			
		||||
* `xslStyleSheets` [MemoryUsageDetails](structures/memory-usage-details.md)
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -26,6 +26,7 @@ The `features` string follows the format of standard browser, but each feature
 | 
			
		|||
has to be a field of `BrowserWindow`'s options.
 | 
			
		||||
 | 
			
		||||
**Notes:**
 | 
			
		||||
 | 
			
		||||
* Node integration will always be disabled in the opened `window` if it is
 | 
			
		||||
  disabled on the parent window.
 | 
			
		||||
* Non-standard features (that are not handled by Chromium or Electron) given in
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue