search

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

Update Doxyfile for neater output, Add documentation for IPlugBase::ProcessDoubleReplacing #83

Closed QrchackOfficial closed 6 years ago

QrchackOfficial commented 6 years ago

Various other tweaks:

Change \return to @return for IControl::GetTooltip() Add documentation for IControl: ParamIdx(), GetValue(), GrayOut(), IsGrayed() Add documentation group for struct IControl::AuxParam Add documentation for GetAuxParam(), AuxParamIdx(), AddAuxParam(), SetAuxParamValueFromPlug() Add documentation for IControl::mParamIdx Add documentation for struct IBitmap::N Add documentation for IPlugBase::ProcessDoubleReplacing() with example code

QrchackOfficial commented 6 years ago

Added in d097eb9d653ac1f3eca12614a6fb9f8e9514001c:

version 2 -> 2.0 Remove Doxyfile comment blocks Remove Perl module output support Remove redundant default values Add Documentation/src to begin static pages support Remove explicit file extension list (it was default anyway) Add "Definition at line X of file Z.h" Remove side panel tree view (GENERATE_TREEVIEW = NO) Remove class diagrams (CLASS_DIAGRAMS = NO)

QrchackOfficial commented 6 years ago

How's that for some useful documentation?

image

olilarkin commented 6 years ago

great, good work!

QrchackOfficial commented 6 years ago

Currently I'm working on setting up Markdown support so we can write some tutorial/static pages as well

olilarkin commented 6 years ago

great, if we can link in all the Readme.md files in various directories, that would be brill