Skip to content

Commit 8afe4c2

Browse files
cztomczakcztomczak
committed
Update docs
1 parent 73c84b2 commit 8afe4c2

File tree

5 files changed

+27
-23
lines changed

5 files changed

+27
-23
lines changed

‎README.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ See the [Examples-README.md](examples/Examples-README.md) file.
6868
- API reference is in the [api/](api) directory:
6969
- [API categories](api/API-categories.md#api-categories)
7070
- [API index](api/API-index.md#api-index)
71-
- Additional documentation is in issues labelled [Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
71+
- Additional documentation is available in [Issues labelled Knowledge Base](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22Knowledge+Base%22)
7272
- To search documentation use GitHub "This repository" search
7373
at the top. To narrow results to documentation only select
7474
"Markdown" in the right pane.
@@ -155,8 +155,8 @@ directly.
155155
- [Tutorial](docs/Tutorial.md)
156156

157157

158-
### API categories
159-
158+
### API categories
159+
160160
#### Modules
161161

162162
* [cefpython](api/cefpython.md#cefpython) module
@@ -190,7 +190,7 @@ directly.
190190
* [WindowUtils](api/WindowUtils.md#windowutils-class) class
191191

192192

193-
#### Handlers (interfaces)
193+
#### Client handlers (interfaces)
194194

195195
* [DisplayHandler](api/DisplayHandler.md#displayhandler-interface)
196196
* [DownloadHandler](api/DownloadHandler.md#downloadhandler)
@@ -211,9 +211,9 @@ directly.
211211
* [StringVisitor](api/StringVisitor.md#stringvisitor-interface) interface
212212
* [WebRequestClient](api/WebRequestClient.md#webrequestclient-interface) interface
213213

214-
215-
### API index
216-
214+
215+
### API index
216+
217217
* [Application settings](api/ApplicationSettings.md#application-settings)
218218
* [accept_language_list](api/ApplicationSettings.md#accept_language_list)
219219
* [auto_zooming](api/ApplicationSettings.md#auto_zooming)
@@ -475,7 +475,9 @@ directly.
475475
* [SetProperty](api/JavascriptBindings.md#setproperty)
476476
* [JavascriptCallback (object)](api/JavascriptCallback.md#javascriptcallback-object)
477477
* [Call](api/JavascriptCallback.md#call)
478-
* [GetName](api/JavascriptCallback.md#getname)
478+
* [GetFrame](api/JavascriptCallback.md#getframe)
479+
* [GetId](api/JavascriptCallback.md#getid)
480+
* [GetFunctionName](api/JavascriptCallback.md#getfunctionname)
479481
* [JavascriptDialogHandler (interface)](api/JavascriptDialogHandler.md#javascriptdialoghandler-interface)
480482
* [Continue](api/JavascriptDialogHandler.md#continue)
481483
* [OnJavascriptDialog](api/JavascriptDialogHandler.md#onjavascriptdialog)

‎api/API-index.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,9 @@
263263
* [SetProperty](JavascriptBindings.md#setproperty)
264264
* [JavascriptCallback (object)](JavascriptCallback.md#javascriptcallback-object)
265265
* [Call](JavascriptCallback.md#call)
266-
* [GetName](JavascriptCallback.md#getname)
266+
* [GetFrame](JavascriptCallback.md#getframe)
267+
* [GetId](JavascriptCallback.md#getid)
268+
* [GetFunctionName](JavascriptCallback.md#getfunctionname)
267269
* [JavascriptDialogHandler (interface)](JavascriptDialogHandler.md#javascriptdialoghandler-interface)
268270
* [Continue](JavascriptDialogHandler.md#continue)
269271
* [OnJavascriptDialog](JavascriptDialogHandler.md#onjavascriptdialog)

‎api/Browser.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Explicitly close the associated DevTools browser, if any.
169169

170170
### DragTargetDragEnter
171171

172-
| | |
172+
| Parameter | Type |
173173
| --- | --- |
174174
| drag_data | [DragData](DragData.md) |
175175
| x | int |
@@ -189,7 +189,7 @@ Description from upstream CEF:
189189

190190
### DragTargetDragOver
191191

192-
| | |
192+
| Parameter | Type |
193193
| --- | --- |
194194
| x | int |
195195
| y | int |
@@ -217,7 +217,7 @@ Description from upstream CEF:
217217

218218
### DragTargetDrop
219219

220-
| | |
220+
| Parameter | Type |
221221
| --- | --- |
222222
| x | int |
223223
| y | int |
@@ -233,7 +233,7 @@ Description from upstream CEF:
233233

234234
### DragSourceEndedAt
235235

236-
| | |
236+
| Parameter | Type |
237237
| --- | --- |
238238
| x | int |
239239
| y | int |

‎api/cefpython.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,10 @@ Table of contents:
3434

3535
### CreateBrowser
3636

37-
Create browser asynchronously (does not return Browser object).
38-
See `CreateBrowserSync()` for params list.
39-
40-
NOTE: currently this is just an alias and actually creates browser
41-
synchronously. The async call to CefCreateBrowser is yet TODO.
37+
Not yet implemented - currently this method just calls [CreateBrowserSync](#createbrowsersync).
38+
In upstream CEF this method creates browser asynchronously. Currently
39+
CEF Python depends on browser being created synchronously in a few parts
40+
of code.
4241

4342

4443
### CreateBrowserSync
@@ -82,8 +81,7 @@ This hook does the following: in case of exception write it to
8281
the "error.log" file, display it to the console, shutdown CEF
8382
and exit application immediately by ignoring "finally" (_exit()).
8483

85-
If you would like to implement a custom hook take a look at the
86-
source code of ExceptHook in the cefpython/src/helpers.pyx file.
84+
See also Tutorial: [Handling Python exceptions](../docs/Tutorial.md#handling-python-exceptions).
8785

8886

8987
### GetAppSetting
@@ -233,7 +231,7 @@ Description from upstream CEF:
233231
| --- | --- |
234232
| threadId | int |
235233
| func | object |
236-
| ... | *args |
234+
| [args..] | mixed |
237235
| __Return__ | void |
238236

239237
Post a task for execution on the thread associated with this task runner. Execution will occur asynchronously. Only Browser process threads are allowed.

‎docs/Knowledge-Base.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Knowledge Base
22

33
Table of contents:
4-
* [Notifications on new releases](#notifications-on-new-releases)
4+
* [Notifications about new releases / commits](#notifications-about-new-releases-commits)
55
* [Changes in API after CEF updates](#changes-in-api-after-cef-updates)
66
* [Differences between Python 2 and Python 3](#differences-between-python-2-and-python-3)
77
* [Location of CEF framework in Mac apps](#location-of-cef-framework-in-mac-apps)
@@ -17,14 +17,16 @@ Table of contents:
1717
* [Security](#security)
1818

1919

20-
## Notifications on new releases
20+
## Notifications about new releases / commits
2121

2222
To be notified of new releases subscribe to this [RSS/Atom feed](../../../releases.atom).
2323

2424
Announcements are also made on the [Forum](https://groups.google.com/d/forum/cefpython).
2525
To be notified of these via email set your Membership and Email settings
2626
and change delivery preference to Daily summaries.
2727

28+
To be notified on new commits subscribe to this [RSS/Atom feed](../../commits/master.atom).
29+
2830

2931
## Changes in API after CEF updates
3032

0 commit comments

Comments
 (0)