search

techyian / MMALSharp

C# wrapper to Broadcom's MMAL with an API to the Raspberry Pi camera.
MIT License
195 stars 33 forks source link

Include XML Documentation in NuGet Package #35

Closed daniel-lerch closed 6 years ago

daniel-lerch commented 6 years ago

Visual Studio allows to make Documentation in Code:

/// <summary>
/// This class provides an interface to the Raspberry Pi camera module. 
/// </summary>
public sealed class MMALCamera 
{
}

But this documentation is not shown as long as you don't generate an XML file at build and include this file in your NuGet package. In Visual Studio you can go to Project Settings->Build and enable XML documentation file. This will generate a MMALSharp.xml in your output directory which you can include to your NuGet package. After this all developers that are using your library will see your documentation in Visual Studio.

techyian commented 6 years ago

Hi Daniel,

Thanks for bringing this to my attention :) I'll get it fixed ASAP.

Ian

daniel-lerch commented 6 years ago

Hi Ian,

I have fixed this issue locally as I made an own build. Do you would like me to make a pull request?

Daniel

techyian commented 6 years ago

Sure, I'll check it over and merge in.

Thanks again, Ian.