Skip to content

Add scaladoc for the FSM lib based on RTD doc#1890

Merged
Dolu1990 merged 1 commit intoSpinalHDL:devfrom
mrcmry:add-fsm-scaladoc
Mar 25, 2026
Merged

Add scaladoc for the FSM lib based on RTD doc#1890
Dolu1990 merged 1 commit intoSpinalHDL:devfrom
mrcmry:add-fsm-scaladoc

Conversation

@mrcmry
Copy link
Copy Markdown
Contributor

@mrcmry mrcmry commented Mar 20, 2026

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:

  • StateMachineSlave is not documented
  • the method innerFsm is 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.
  • I added a scaladoc description as "used internally" for getStateMachineAccessor whenIsActiveWithPriority. Perhaps we should make them protected or private, but it could break things, I don't know

Impact on code generation

Do not change the scala code an thus the generation as well.

@Dolu1990
Copy link
Copy Markdown
Member

Thanks ^^

@Dolu1990 Dolu1990 merged commit af346a0 into SpinalHDL:dev Mar 25, 2026
53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants