Add API versions and improve playlist API docs #857
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Doxygen documentation now mentions that the playlist library will set the preset switch callbacks in projectM and needs them to function properly. Added hints on how to restore functionality if needed.
kblaschke
force-pushed
the
add-api-versions-and-improve-playlist-api-docs
branch
from
9d6aa98 to
e90dc28
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added
@sincetags for all API files, functions and types stating since which projectM release each one is available. This will make it easier for developers to decide on which function they want to use to support older versions, or resolve functions available in newer versions at runtime to make use of a wider range or projectM shared library versions and features based on availability.Also added clarifications in the API docs for the issue discussed in #854 regarding how callbacks are registered and reset by the playlist library.
Note this one includes the changes already PR'd in #856 - ignore those, I'll lazily merge this one after the copyright date changeset to save me a rebase.