abpframework / abpframework/abp

Add XML Documentation Comments for the missing API's

Open
#22,111 1 comment 1 reaction 1 assignee View on GitHub

@maliming is already working on this.

Since Feb 10, 2025.

effort-sm enhancement
Dominant language
C#
Stars
14.4k
Forks
3.7k
Avg merge
15h 32m
Merged PRs (30d)
106

Description

We should write XML documentation comments for the missing APIs. The IEventBus service is a great example of a well-documented service:

https://github.com/abpframework/abp/blob/8d1d89ac7fe3082e342add226e97f417e7f9d287/framework/src/Volo.Abp.EventBus.Abstractions/Volo/Abp/EventBus/IEventBus.cs#L6-L16

However, most of our services, lack of XML documentation, and we should at least write XML documentation comments for the important base services. Otherwise, the developers spend much times by trying to understand which method suits for them and don't understand the reason of some methods.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.