This repository has been archived by the owner on Jun 27, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from milosmns/feature/docs-generator
Docs generator and HTML
- Loading branch information
Showing
99 changed files
with
6,778 additions
and
4 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <HTML> | ||
| <HEAD> | ||
| <meta charset="UTF-8"> | ||
| <title>alltypes - kssm</title> | ||
| <link rel="stylesheet" href="../../style.css"> | ||
| </HEAD> | ||
| <BODY> | ||
| <h3>All Types</h3> | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api/-action/index.html">me.angrybyte.kssm.api.Action</a></h5> | ||
| <p>A fundamental building block of a <a href="../me.angrybyte.kssm.api/-state-machine/index.html">StateMachine</a>. | ||
| In <a href="https://i.imgur.com/rhDX2ux.png">this example</a> that would be <code>A-to-B</code>, <code>B-to-C</code>, <code>C to A</code> and <code>C : Self</code>.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api/-error-handler.html">me.angrybyte.kssm.api.ErrorHandler</a></h5> | ||
| <p>A suspending shorthand for reacting to <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a>s coming from a <a href="../me.angrybyte.kssm.api/-state-machine/index.html">StateMachine</a>.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api.data/-incubation-exception.html">me.angrybyte.kssm.api.data.IncubationException</a></h5> | ||
| <p>Signals the catcher that <a href="../me.angrybyte.kssm.api/-state-machine/index.html">StateMachine</a> is in incubation state. | ||
| Used to replace <code>null</code> in the observable flow of errors.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api.data/-incubation-passed-exception/index.html">me.angrybyte.kssm.api.data.IncubationPassedException</a></h5> | ||
| <p>Signals the catcher that <a href="../me.angrybyte.kssm.api/-state-machine/index.html">StateMachine</a> has passed the incubation state. | ||
| No more configuration changes should be made on the state machine instance.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api.data/-no-mapping-exception/index.html">me.angrybyte.kssm.api.data.NoMappingException</a></h5> | ||
| <p>Signals the catcher that <a href="../me.angrybyte.kssm.api/-state-machine/index.html">StateMachine</a> doesn't have the mapping registered for the given state and action. | ||
| The easiest fix is to check your mappings and add the missing ones.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.impl.action/-singleton-action/index.html">me.angrybyte.kssm.impl.action.SingletonAction</a></h5> | ||
| <p>A simple <a href="../me.angrybyte.kssm.api/-action/index.html">Action</a> implementation that uses the inheritor's class name as action name. | ||
| It doesn't carry any payload and it's meant to be used with <code>object</code>s. For example:</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.impl.state/-singleton-state/index.html">me.angrybyte.kssm.impl.state.SingletonState</a></h5> | ||
| <p>A simple <a href="../me.angrybyte.kssm.api/-state/index.html">State</a> implementation that uses the inheritor's class name as state name. | ||
| It doesn't carry any payload and it's meant to be used with <code>object</code>s. For example:</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api/-state/index.html">me.angrybyte.kssm.api.State</a></h5> | ||
| <p>A fundamental building block of a <a href="../me.angrybyte.kssm.api/-state-machine/index.html">StateMachine</a>. | ||
| In <a href="https://i.imgur.com/rhDX2ux.png">this example</a> that would be <code>State A</code>, <code>State B</code> and <code>State C</code>.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api/-state-machine/index.html">me.angrybyte.kssm.api.StateMachine</a></h5> | ||
| <p>The public-facing API for configuring, using and observing changes within a finite state machine.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.dsl/-state-machine-dsl/index.html">me.angrybyte.kssm.dsl.StateMachineDsl</a></h5> | ||
| <p>The DSL (domain-specific language) wrapper. Allows easy state machine configuration and instantiation.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api.data/-state-mapping/index.html">me.angrybyte.kssm.api.data.StateMapping</a></h5> | ||
| <p>Keeps information about a particular state-to-state transition mapping. | ||
| You should provide an action at creation time, and both <strong>start</strong> and <strong>end</strong> states surrounding the action.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.dsl/-state-vector/index.html">me.angrybyte.kssm.dsl.StateVector</a></h5> | ||
| <p>Holds a <a href="../me.angrybyte.kssm.api/-state/index.html">State</a> and an <a href="../me.angrybyte.kssm.api/-action/index.html">Action</a>, without knowing anything about the resulting state.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api.data/-transition/index.html">me.angrybyte.kssm.api.data.Transition</a></h5> | ||
| <p>In most ways a structurally similar data model to <a href="../me.angrybyte.kssm.api.data/-state-mapping/index.html">StateMapping</a>. In contrast to <a href="../me.angrybyte.kssm.api.data/-state-mapping/index.html">StateMapping</a>, a <code>Transition</code> is | ||
| mostly used to report already processed state changes to the outside world.</p> | ||
| </tr> | ||
| <tr> | ||
| <h5><a href="../me.angrybyte.kssm.api/-transition-handler.html">me.angrybyte.kssm.api.TransitionHandler</a></h5> | ||
| <p>A suspending shorthand for reacting to <a href="../me.angrybyte.kssm.api.data/-transition/index.html">Transition</a>s coming from a <a href="../me.angrybyte.kssm.api/-state-machine/index.html">StateMachine</a>.</p> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </BODY> | ||
| </HTML> |
Oops, something went wrong.