summaryrefslogtreecommitdiff
path: root/spec/spec/interface-function-definition.yml
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-25 09:42:37 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-05-28 10:38:23 +0200
commit06c7b22a67829732b0b14829416ecb32b58a9c3a (patch)
treed52c80cd42ba5b6da1a2a36560c144acd402af24 /spec/spec/interface-function-definition.yml
parent0f5d1db239d5671c048b827692fb354fafb6b034 (diff)
spec: Add specification of interface items
Diffstat (limited to 'spec/spec/interface-function-definition.yml')
-rw-r--r--spec/spec/interface-function-definition.yml36
1 files changed, 36 insertions, 0 deletions
diff --git a/spec/spec/interface-function-definition.yml b/spec/spec/interface-function-definition.yml
new file mode 100644
index 00000000..1d05127d
--- /dev/null
+++ b/spec/spec/interface-function-definition.yml
@@ -0,0 +1,36 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+links:
+- role: spec-member
+ uid: root
+spec-description: null
+spec-example: null
+spec-info:
+ dict:
+ attributes:
+ body:
+ description: |
+ If the value is present, then it shall be the definition of a static
+ inline function. On the function definition a context-sensitive
+ substitution of item variables is performed. If no value is present,
+ then the function is declared as an external function.
+ spec-type: optional-str
+ params:
+ description: |
+ It shall be the list of parameter declarations of the function. On
+ the function parameter declarations a context-sensitive substitution
+ of item variables is performed.
+ spec-type: list-str
+ return:
+ description: |
+ It shall be the function return type. On the return type a
+ context-sensitive substitution of item variables is performed.
+ spec-type: str
+ description: |
+ This set of attributes specifies a function definition.
+ required-attributes: all
+spec-name: Interface Function Definition
+spec-type: interface-function-definition
+type: spec