Public Member Functions | List of all members
ProcessorDocumentation Class Reference

A object that holds all the documentation available for a certain processor. More...

Public Member Functions

MarkdownHelpButton * createHelpButtonForParameter (int index, Component *componentToAttachTo)
 This creates and attaches a markdown help button to the given component.
 

Detailed Description

A object that holds all the documentation available for a certain processor.

In order to use it, subclass it as a inner class of your processor called ProcessorType::Documentation and use the preprocessor macros ADD_PARAMETER_DOC and ADD_CHAIN_DOC and the addLine() method.

If you call the immediate base class constructor, it will make sure that all common parameters will be documented correctly.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.