Skip to content

Commit

Permalink
Clarification.
Browse files Browse the repository at this point in the history
  • Loading branch information
katef committed Aug 7, 2024
1 parent bb304c3 commit 237d809
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions include/fsm/print.h
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,17 @@ struct fsm_hooks {

/*
* Print an FSM to the given file stream. The output is written in the format
* specified by the lang enum. Not all languages support all options.
* specified by the lang enum.
*
* Not all languages support all options, and fsm_print will ENOTSUP where
* these are not possible. This is different to when an option is possible
* but simply not yet implemented, where fsm_print() will print a message
* to stderr and exit.
*
* The code generation for the typical case of matching input require the FSM
* to be a DFA. As opposed to e.g. FSM_PRINT_API, which generates code for other
* purposes, and does not place particular expecations on the FSM.
* to be a DFA, and will EINVAL if the FSM is not a DFA. As opposed to e.g.
* FSM_PRINT_API, which generates code for other purposes, and does not place
* particular expecations on the FSM.
*
* The output options may be NULL, indicating to use defaults.
*
Expand Down

0 comments on commit 237d809

Please sign in to comment.