cefsharp/CefSharp

Fix/Add Missing Xml Documentation

Open

#1,162 opened on Jul 31, 2015

View on GitHub
 (4 comments) (0 reactions) (0 assignees)C# (2,940 forks)batch import
Good First Issueup-for-grabs

Repository metrics

Stars
 (10,221 stars)
PR merge metrics
 (Avg merge 3d 17h) (5 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Build the project in release mode to identify compiler warnings about missing XML documentation. Locate the public types and members without comments and add appropriate documentation describing their purpose and usage.
Tech stack
csharp
Domain
desktop
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75