Skip to content

/ CefSharp

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix/Add Missing Xml Documentation #1162

Open
amaitland opened this issue Jul 31, 2015 · 2 comments
Open

Fix/Add Missing Xml Documentation #1162

amaitland opened this issue Jul 31, 2015 · 2 comments
Labels
up-for-grabs
Milestone
3000

Comments

@amaitland
Copy link
Member

@amaitland amaitland commented Jul 31, 2015

When building in release mode the compiler will kindly point out all the public places that don't have xml comments, we should add/fix these in preparation for releasing a symbols package.
@amaitland amaitland added this to the 43.0.0 milestone Jul 31, 2015
@amaitland amaitland changed the title Fix/Add Missing Xml Documents Fix/Add Missing Xml Documentation Aug 3, 2015
@amaitland amaitland modified the milestones: 45.0.0, 43.0.0 Aug 31, 2015
@amaitland amaitland modified the milestones: 47.0.0, 45.0.0 Oct 11, 2015
@Atvaark Atvaark mentioned this issue Nov 3, 2015
Merged
@amaitland amaitland modified the milestones: 49.0.0, 47.0.0 Dec 2, 2015
@amaitland amaitland modified the milestones: 49.0.0, 51.0.0 Mar 2, 2016
@amaitland
Copy link
Member Author

@amaitland amaitland commented Mar 21, 2016

VC++ classes that need doc

  • CefSettings
  • BrowserSettings
  • RequestContextSettings
  • RequestContext (IRequestContext has documentations, copy from there)

Classes in the CefSharp project, need to be documented as well.

The CEF API is available at http://magpcss.org/ceforum/apidocs3/index-all.html (it's not always at the latest version, see top right corner).

Conventions from mapping the CEF API

  • CefSettings.browser_subprocess_path becomes CefSettings.BrowserSubProcessPath
  • CursorType.CT_POINTER becomes CefCursorType.Pointer

There are some inconsistencies with the naming of classes, some are prefixed with Cef and some aren't for historic reasons it's hard to change these now as it would break backwards compatibility.

All of the Handler interfaces should be consistent in naming though, CefResourceHandler maps to IResourceHandler, that convention should apply to all of them.
@dga711 dga711 mentioned this issue Mar 24, 2016
Merged
@amaitland amaitland modified the milestones: 51.0.0, 3000 Jun 7, 2016
@amaitland
Copy link
Member Author

@amaitland amaitland commented Jun 15, 2016

Basic API Doc is now available at http://cefsharp.github.io/api/51.0.0/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
up-for-grabs
Projects
None yet
Milestone
  3000
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
@amaitland
You can’t perform that action at this time.