First test on Simantics documentation using gitbook

[simantics/platform.git] / docs / Developer / Database / Functions.md

diff --git a/docs/Developer/Database/Functions.md b/docs/Developer/Database/Functions.md
new file mode 100644 (file)
index 0000000..1552d9e
--- /dev/null
+++ b/docs/Developer/Database/Functions.md
@@ -0,0 +1,15 @@
+# Intro\r
+\r
+This section deals with the following specifications\r
+\r
+* Specification of generic functions applicable in the Simantics framework\r
+* Specification of functions attached to types (methods)\r
+* Specification of functions with side-effects (operations or commands)\r
+* Automatically generated code based on semantic model about functions (stubs)\r
+\r
+## Specification\r
+\r
+* Functions are objects implementing the interface `org.simantics.scl.runtime.function.Function`.\r
+* We have a type `Value` (?) that can be adapted to an SCL value (in particular to a function).\r
+* We have a relation `HasType` (?) Value -> String that specifies the SCL type of the value\r
+* Operations are functions that return an object implementing `WriteResult`.\r