Fix/Add Missing Xml Documentation
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.
VC++ classes that need doc
-
CefSettings -
BrowserSettings -
RequestContextSettings -
RequestContext(IRequestContexthas 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_pathbecomesCefSettings.BrowserSubProcessPath -
CursorType.CT_POINTERbecomesCefCursorType.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.
Basic API Doc is now available at http://cefsharp.github.io/api/
Hello,
is there a reason no xml documentation is included in the netcore nuget packages?
P.S. thank you for the good work!
is there a reason no xml documentation is included in the netcore nuget packages?
We need Microsoft to resolve https://github.com/dotnet/sdk/issues/1458