PrismLibrary / PrismLibrary/Prism
Add Missing XML Docs
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 6.8k
- Forks
- 1.6k
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 1
Description
Summary
Many API's are currently lacking XML docs or have invalid markup. As we begin to explore adding API documentation to the Prism Docs, we need to update the existing codebase with more complete XML docs so that these docs can be generated for the docs site.
HACKTOBERFEST UPDATE
Thank you for joining us for your Hacktoberfest contributions... Please take some time to familiarize yourself with this issue. If you submit PR's for a single method in a single class please expect your PR to be closed as invalid
NOTE
While updated and added XML docs should include Summaries, and information for parameters/return values, it will often be better to ensure that remarks and examples are included as this will make the generated API docs more useful. Additional information on proper doc tags can be found here.
/// <summary>
/// The GetZero method.
/// </summary>
/// <example>
/// This sample shows how to call the <see cref="GetZero"/> method.
/// <code>
/// class TestClass
/// {
/// static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>
public static int GetZero()
{
return 0;
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the C# API surface for missing or invalid XML documentation, using the issue's Microsoft recommended-tags guidance and the Prism Docs generation goal as context. Done means adding valid summaries and parameter/return documentation, with remarks or examples where useful, across more than a single method in one class.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100