com.io7m.jfsm 2.0.0 Documentation ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Contents ───────────────────────────────────────────────────────────────────────────── 1 Package Information ................................................... pkg 1.1 Orientation ........................................... pkg.orientation 1.2 Installation .............................................. pkg.install 1.3 Platform Specific Issues ................................. pkg.platform 1.4 License ................................................... pkg.license 2 API Documentation ......................................................... 2.1 API Documentation ................................................. api 1 Package Information [id: pkg] ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Contents ───────────────────────────────────────────────────────────────────────────── 1.1 Orientation ............................................. pkg.orientation 1.1.1 Overview ................................... pkg.orientation.overview 1.2 Installation ................................................ pkg.install 1.2.1 Source compilation ............................... pkg.install.source 1.2.2 Maven ............................................. pkg.install.maven 1.3 Platform Specific Issues ................................... pkg.platform 1.4 License ..................................................... pkg.license 1.1 Orientation [id: pkg.orientation] 1.1.1 Overview [id: pkg.orientation.overview] 1 The com.io7m.jfsm package implements something. 1.2 Installation [id: pkg.install] 1.2.1 Source compilation [id: pkg.install.source] 1 The project can be compiled and installed with Maven [url: http://maven.apache.org]: 2 $ mvn -C clean install 1.2.2 Maven [id: pkg.install.maven] 1 Regular releases are made to the Central Repository [url: http://search.maven.org/#search%7Cga%7C1%7Ccom.io7m.jfsm]. 2 All io7m.com [url: https://www.io7m.com] packages use Semantic Versioning [0], which implies that it is always safe to use version ranges with an exclusive upper bound equal to the next major version - the API of the package will not change in a backwards-incompatible manner before the next major version. 1.3 Platform Specific Issues [id: pkg.platform] 1 There are no known platform-specific issues. 1.4 License [id: pkg.license] 1 All files distributed with the com.io7m.jfsm package are placed under the following license: 1.4.2.2 License ─────────────── Copyright © 2016 Mark Raynsford https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 2 API Documentation ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ Contents ───────────────────────────────────────────────────────────────────────────── 2.1 API Documentation ................................................... api 2.1.1 Javadoc ............................................................. 2.1 API Documentation [id: api] 2.1.1 Javadoc 1 API documentation for the package is provided via the included Javadoc [url: apidocs]. Footnotes ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ [0] http://semver.org [url: http://semver.org]