Simulink: add documentation of inputs to FAST_Library.h #1176
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
Also add note in the Simulink glue-code directory about where Simulink channel information can be found.
rafmudaf
approved these changes
Jul 18, 2022
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.
This is ready for merging
Feature or improvement description
The change to the Simulink inputs was not documented well in the 3.1.0 release. This PR adds a current list of inputs to FAST_Library.h and a readme in the
glue-codes/simulinkdirectory pointing to where this can be foundRelated issue, if one exists
#1163
Impacted areas of the software
This is documentation only (comment lines were added within the code).
Additional supporting information
It took me longer than expected to figure out what the channel list should be even though I wrote the code. So I added it here so I can more easily find it in future development, and can point Simulink users and other developers to it. This could be added to readthedocs, but we don't currently have any info there for the Simulink interface.