olilarkin / wdl-ol

Enhanced version of Cockos' iPlug - A simple-to-use C++ framework for developing cross platform audio plugins and targeting multiple plugin APIs with the same code. VST / VST3 / Audiounit / RTAS / AAX (Native) formats supported. NOTE: THIS IS OBSOLETE, PLEASE SEE IPLUG2:
https://github.com/iplug2
936 stars 187 forks source link

Add documentation for ByteChunk, IBitmap #85

Closed QrchackOfficial closed 6 years ago

QrchackOfficial commented 6 years ago

Please do check if the sizes are actually in bytes, I'm doing guesswork by looking at the fact there's memcpy() and the likes used in the implementation

QrchackOfficial commented 6 years ago

Please check if I understand IBitmap correctly before merging

QrchackOfficial commented 6 years ago

cb7053b1eb460c466447deaecd385a377774e4c8 looks really sweet, especially when you're using Visual Studio for Peek Definition:

image

This results in the following output from Doxygen as well:

image

QrchackOfficial commented 6 years ago

Also I'd suggest merging (possibly without IPlug/IGraphics/IGraphicsStructs.h as it's subject to change) while the codebase hasn't changed all that much because of documentation, should be way easier to merge than after we think we're done (and suddenly there's tons of conflits to be resolved)

olilarkin commented 6 years ago

Are you talking about merging this? I will, just give me a sec

olilarkin commented 6 years ago

I’m not going to merge to master yet if that’s what you meant, lots of Apis need to be sorted out before people start using them in anger

QrchackOfficial commented 6 years ago

Sure, I meant into iplugquake, just though it'll save tons of conflict resolving later on if this pull request doesn't just kind of sits in limbo for a month

olilarkin commented 6 years ago

okay I've merged, with a few changes. I don't think we need to document .cpp files. it should be in the header files. Also it would be great to try and keep the doxygen comments as compact as possible. where something can all go on 1 line