diff options
author | Stefan Radomski <github@mintwerk.de> | 2016-05-19 08:03:50 (GMT) |
---|---|---|
committer | Stefan Radomski <github@mintwerk.de> | 2016-05-19 08:03:50 (GMT) |
commit | 5de792adc6796b0f03d62124765b4af0676dde46 (patch) | |
tree | e700d6b008b21c037aebcc1882fd9286920b2987 /docs/doxygen.dox | |
parent | f8e0c96fddfdd5f086e1bd973d6b0a19c39c93da (diff) | |
download | uscxml-5de792adc6796b0f03d62124765b4af0676dde46.zip uscxml-5de792adc6796b0f03d62124765b4af0676dde46.tar.gz uscxml-5de792adc6796b0f03d62124765b4af0676dde46.tar.bz2 |
Refactored for public headers and started documentation
Diffstat (limited to 'docs/doxygen.dox')
-rw-r--r-- | docs/doxygen.dox | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/doxygen.dox b/docs/doxygen.dox new file mode 100644 index 0000000..5b861fb --- /dev/null +++ b/docs/doxygen.dox @@ -0,0 +1,56 @@ +/** + * @defgroup extension Extension Points + * @brief Available extension points for the uSCXML intepreter. + * + * @{ + * @defgroup ioproc I/O Processors + * @brief Custom In-/Ouput processors. + +I/O processors will allow to send and receive events from and to a running +SCXML instance. + + * @defgroup invoker Invokers + * @brief Types of components for the invoke element to summon. + +Invokers will allow to specify types of external components to instantiate and +communicate with via events. + + * @defgroup datamodel Data-Models + * @brief Additional data-models for embedded scriptings. + +Data-models provide a syntax and semantic for an embedded scripting language. +Within the SCXML standard there are normative descriptions of ECMAScript and an +XPath description that was removed before recommendation status. + + * @defgroup element Executable Content + * @brief Custom XML elements for executable content. + +An extension point to register custom elements as executable content. + + * @} + + * @defgroup interpreter Interpreter + * @brief The components constituting the core of the interpreter. + * @{ + + * @defgroup microstep Microstep + * @brief Implementations of the micro-step(t) algorithm. + + * @defgroup execcontent Content Executor + * @brief Instances to process executable content as part of a micro-step. + + * @defgroup eventqueue Event Queue + * @brief Implementation of proper and delayed event queues. + + * @} + + * @defgroup callback Callbacks + * @brief Callback interfaces. + + * @defgroup facade Facades + * @brief User-facing facades for the implementations. + + * @defgroup abstract Interfaces + * @brief Base classes as interfaces for implementations. + + */ |