cefsharp/CefSharp

Fix/Add Missing Xml Documentation

Open

#1162 opened on Jul 31, 2015

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

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

Tech stack
csharp
Domain
documentation
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic C# knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Build the project in Release mode to generate warnings for missing XML documentation. Then navigate to each warned member and add a summary comment. Pay attention to the existing comment style in the codebase.