Add scaladoc for the FSM lib based on RTD doc#1890
Merged
Dolu1990 merged 1 commit intoSpinalHDL:devfrom Mar 25, 2026
Merged
Conversation
Member
|
Thanks ^^ |
This file contains hidden or 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
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.
I used the SpinalDoc-RTD to add scaladoc the the state machine library.
This way a developer can quickly access the doc when coding.
Still open but not blocking for PR:
StateMachineSlaveis not documentedinnerFsmis not used anywhere (at least in this repos code). It's a bit confusing, because some example use classes or variables using this name. Perhaps we should remote it or deprecate it.getStateMachineAccessorwhenIsActiveWithPriority. Perhaps we should make them protected or private, but it could break things, I don't knowImpact on code generation
Do not change the scala code an thus the generation as well.