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

Configured XML documentation output #36

Closed daniel-lerch closed 6 years ago

daniel-lerch commented 6 years ago

I configured the output of XML documentation files. The compiler will now create an XML file in the output directory which resolves #35 .

The <Service Include="" /> tag in tests/MMALSharp.Tests/MMALSharp.Tests.csproj was automatically made by Visual Studio in order to optimize startup performance with XUnit (see stackoverflow).

daniel-lerch commented 6 years ago

Maybe we should suppress warning CS1591 "Missing XML comment for publicy visible type or member" because we have 1830 warnings and the AppVeyor output is completely boated by warning messages.

techyian commented 6 years ago

Thanks for this Daniel. I'm in two minds about suppressing the warnings - it would be a good exercise to try and work through the remaining Managed methods that are missing XML documentation. I can see the majority however are coming from the native areas so I'm happy to suppress in these files.

techyian commented 6 years ago

Added #37 for the remaining areas and suppress in native areas.