Documenting NLayer APIs.

naudio / NLayer

MPEG 1 & 2 Decoder for Layers 1, 2, & 3

MIT License

124 stars 30 forks source link

Documenting NLayer APIs. #3

Closed Blealtan closed 7 years ago

Blealtan commented 7 years ago

Exposed APIs of NLayer are fully documented and corresponding example is added to README.md. Language usage might be checked since I'm not a native English speaker. Also, I'm sorry for previous offense when discussing around the independence towards NAudio, and I hope I can work on this project and help make it better.

markheath commented 7 years ago

OK, thanks for this. A few comments could perhaps be improved, but it's nice to have better documentation. I'll merge this in in a few days unless @ioctlLR has any objections/suggestions?

ioctlLR commented 7 years ago

Looks fine to me. We might want to also change the "ported from JLayer" comment to say something different while we're making changes... I'd vote to just drop that piece entirely.

markheath commented 7 years ago

OK let's get this in and we can make further tweaks in a separate commit