Links to API documentation? about wdl-ol HOT 24 CLOSED

A new version is coming soon with more documentation

from wdl-ol.

ooh, looking forward to it. It's been literally decades since I last did anything in C++, so being able to hack on some VST effects and synths is proving incredibly enjoyable.

from wdl-ol.

@olilarkin this is great news! Do we have an ETA?

from wdl-ol.

not enough hours in the day at the moment, but much work is done. I just set up a Patreon, if you would like to support my efforts

https://www.patreon.com/posts/16142537

from wdl-ol.

Hmm can't really do it this way (gotta keep the uni budget in check), but let me know whenever you could use some help with development, would love to up my low-level skills

from wdl-ol.

I could with some help with development since about 10 years ago!

from wdl-ol.

I am also a student. if you think it needs documentation, roll up your sleeves and do it yourself! that's what I've done over many years

from wdl-ol.

That's certainly not a bad starting point, shoot the easy fixes at me and we'll see what can be done

from wdl-ol.

Not too focused on documentation (although I do think it's needed further down the road), high-DPI, UI scaling, CMake support and all the new C++ goodness sounds fun as well

from wdl-ol.

I suppose I should be on 4d0b2bb?

from wdl-ol.

this is where the new work is at, +some things I haven't merged in cleanly yet

https://github.com/olilarkin/wdl-ol/tree/iplugquake

if someone wanted to fork it and start setting it up for cmake that would be much appreciated (a few people have done stuff already but I can't merge with my latest changes).

decent pull requests are a great way to contribute to the project (although I haven't been able to merge many nice things people have sent over the years due to time limitations).

from wdl-ol.

Got it. Are we able to compile on MSVC 2017 currently or should I switch to 2015 for now?

from wdl-ol.

I will try and make sure vs2017 is compiling today/next few days. I develop on macOS in the first instance so sometimes windows support breaks.

some reading to do here (start of some documentation): https://github.com/olilarkin/wdl-ol/blob/iplugquake/IPlug2-doc.md

from wdl-ol.

Is it a good time to work on documentation? No significant API changes expected? I'd avoid writing documentation if stuff's about to change in a month or two.

from wdl-ol.

there will be some. the kind of documentation that would be really helpful as if you could just get some placeholder stuff inline for a nice doxygen site. I would like to properly comment IPlugBase, IParam, IControl and IGraphics, alse IMidimsg, IRect. I haven't had time to really figure out doxygen, so if you could do that, and do pull requests that merge cleanly with my latest IPlug even if you don't understand the apis yourself - that make any sense?

from wdl-ol.

I can fill in the details

from wdl-ol.

I guess. I didn't try Doxygen yet, but I have played around with Sandcastle, which is a .NET-specific tool. I'll have a look around how Doxygen works and see how we could set it up to generate some documentation. Do we want to just autogenerate, or do we need hand-crafted pages as well? I think some beginner tutorials should probably be there as well

from wdl-ol.

that would be great, some methods are self-explanatory but it would be really good to have proper documentation of arguments etc., although this will bloat the code a bit. I plan to do some tutorials as well

from wdl-ol.

What's the current state of documentation? Do we have fairly documented arguments etc. or not really?

from wdl-ol.

if you installed doxygen navigate to the IPlug folder and run doxygen there

https://github.com/olilarkin/wdl-ol/blob/iplugquake/IPlug/Doxyfile

you should see the status. there is no proper doxygen markup, just the odd comment here and there. have a look at the JUCE source code for example of where I'd like to get to

from wdl-ol.

started work here:
e6c970e

from wdl-ol.

Closing this issue because basically it just needs to be done. If anyone wants to help be my guest! Started the work

from wdl-ol.

It would be useful to file a new issue for that "doing the work" part then, with a "help wanted" label to encourage people to help out on it =)

(work without a corresponding issue is work contributors can't discover needs doing)

from wdl-ol.

Good point @Pomax

from wdl-ol.