Skip to content
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

Fix/Add Missing Xml Documentation #1162

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

Fix/Add Missing Xml Documentation #1162

amaitland opened this issue Jul 31, 2015 · 4 comments
Labels
Good First Issue good first issue Issues that are suitable for first-time contributors. up-for-grabs
Milestone

Comments

@amaitland
Copy link
Member

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
@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

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.

@amaitland amaitland modified the milestones: 51.0.0, 3000 Jun 7, 2016
@amaitland
Copy link
Member Author

amaitland commented Jun 15, 2016

Basic API Doc is now available at http://cefsharp.github.io/api/

@nylu
Copy link

nylu commented Aug 19, 2021

Hello,

is there a reason no xml documentation is included in the netcore nuget packages?

P.S. thank you for the good work!

@amaitland
Copy link
Member Author

is there a reason no xml documentation is included in the netcore nuget packages?

We need Microsoft to resolve dotnet/sdk#1458

@amaitland amaitland added the Good First Issue good first issue Issues that are suitable for first-time contributors. label Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue good first issue Issues that are suitable for first-time contributors. up-for-grabs
Projects
None yet
Development

No branches or pull requests

2 participants