Enable generation of SIPSorcery.xml documentation file

sipsorcery-org / sipsorcery

A WebRTC, SIP and VoIP library for C# and .NET. Designed for real-time communications apps.

https://sipsorcery-org.github.io/sipsorcery

Other

1.39k stars 424 forks source link

Enable generation of SIPSorcery.xml documentation file #1106

Closed exyi closed 2 months ago

exyi commented 3 months ago

It should provide the summaries on hover in IDEs, when using the SIPSorcery nuget package. Currently it only works when SIPSorcery is referenced from source (at least in VSCode and Rider)

Enabled GenerateDocumentationFile in SIPSorcery.csproj
Disabled "missing XML comment" warnings
Fixed most malformed XML comments (warnings about these are not disabled)

sipsorcery commented 2 months ago

Thanks!