CefSharp icon indicating copy to clipboard operation
CefSharp copied to clipboard

Fix/Add Missing Xml Documentation

Open amaitland opened this issue 10 years ago • 4 comments

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 avatar Jul 31 '15 04:07 amaitland

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 avatar Mar 21 '16 21:03 amaitland

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

amaitland avatar Jun 15 '16 06:06 amaitland

Hello,

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

P.S. thank you for the good work!

nylu avatar Aug 19 '21 23:08 nylu

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

amaitland avatar Aug 20 '21 00:08 amaitland