summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJuergen Bocklage-Ryannel <jbocklage-ryannel@luxoft.com>2018-11-01 16:20:59 -0400
committerJuergen Bocklage-Ryannel <jbocklage-ryannel@luxoft.com>2018-11-01 17:37:53 -0400
commit4131d2a2d7ba644af4fb632601f2f15853f621a7 (patch)
tree56152e2055c6f3cd059242e8cb05e58f7a39431c
parent267f694abbc08abb7cc7b0756ba0b4dadc11cf53 (diff)
downloadqtivi-qface-4131d2a2d7ba644af4fb632601f2f15853f621a7.tar.gz
ensure correct domain model vocabulary is used
-rw-r--r--docs/domain.rst4
-rw-r--r--docs/extending.rst6
-rw-r--r--docs/usage.rst2
3 files changed, 7 insertions, 5 deletions
diff --git a/docs/domain.rst b/docs/domain.rst
index bf8f1c1..df27987 100644
--- a/docs/domain.rst
+++ b/docs/domain.rst
@@ -12,10 +12,10 @@ The IDL is converted into an in memory domain model (see qface/idl/domain.py)
- System
- Module
- Import
- - Service
+ - Interface
- Property
- Operation
- - Event
+ - Signal
- Enum
- Flag
- Struct
diff --git a/docs/extending.rst b/docs/extending.rst
index 910c086..faf4ccb 100644
--- a/docs/extending.rst
+++ b/docs/extending.rst
@@ -81,10 +81,12 @@ The rules document is divided into several targets. Each target can have an own
<target>:
<symbol>:
- context: {}
- destination: ''
+ context: { <key>: <value> }
+ destination: <path>
documents:
<target>:<source>
+ preserve:
+ <target>:<source>
* ``<target>`` is a name of the current target (e.g. client, server, plugin)
* ``<symbol>`` must be either system, module, interface, struct or enum
diff --git a/docs/usage.rst b/docs/usage.rst
index 74a1714..87216c7 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -57,7 +57,7 @@ This script reads the input directory and returns a system object from the domai
{% for module in system.modules %}
{%- for interface in module.interfaces -%}
- SERVICE, {{module}}.{{interface}}
+ INTERFACE, {{module}}.{{interface}}
{% endfor -%}
{%- for struct in module.structs -%}
STRUCT , {{module}}.{{struct}}