diff options
author | 2024-04-09 20:47:46 +0200 | |
---|---|---|
committer | 2024-04-09 20:48:32 +0200 | |
commit | 7e651ada035c88446ff620ffc3fb7eb8f23cbf7d (patch) | |
tree | 933e1d08f7c9dc7b8f28a36fe0051287be7f3ed7 /subprojects/docs/src/docs-api | |
parent | docs: add embedded video (diff) | |
download | refinery-7e651ada035c88446ff620ffc3fb7eb8f23cbf7d.tar.gz refinery-7e651ada035c88446ff620ffc3fb7eb8f23cbf7d.tar.zst refinery-7e651ada035c88446ff620ffc3fb7eb8f23cbf7d.zip |
docs: add Javadoc
Diffstat (limited to 'subprojects/docs/src/docs-api')
-rw-r--r-- | subprojects/docs/src/docs-api/javadoc.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/subprojects/docs/src/docs-api/javadoc.md b/subprojects/docs/src/docs-api/javadoc.md index 09b3e4f7..7e39b9b9 100644 --- a/subprojects/docs/src/docs-api/javadoc.md +++ b/subprojects/docs/src/docs-api/javadoc.md | |||
@@ -1,7 +1,42 @@ | |||
1 | --- | 1 | --- |
2 | SPDX-FileCopyrightText: 2024 The Refinery Authors | 2 | SPDX-FileCopyrightText: 2024 The Refinery Authors |
3 | SPDX-License-Identifier: EPL-2.0 | 3 | SPDX-License-Identifier: EPL-2.0 |
4 | description: API documentation for Refinery components automatically generated by Javadoc | ||
4 | sidebar_position: 999 | 5 | sidebar_position: 999 |
5 | --- | 6 | --- |
6 | 7 | ||
7 | # Javadoc | 8 | # Javadoc |
9 | |||
10 | Here you can find API documentation for Refinery components automatically generated by Javadoc. We recommend reading the [Programming guide](/api) first to understand how to use these components. | ||
11 | |||
12 | # Refinery | ||
13 | |||
14 | * [`tools.refinery:refinery-generator`](pathname://refinery-generator) | ||
15 | * [`tools.refinery:refinery-generator-cli`](pathname://refinery-generator-cli) | ||
16 | * [`tools.refinery:refinery-language`](pathname://refinery-language) | ||
17 | * [`tools.refinery:refinery-language-ide`](pathname://refinery-language-ide) | ||
18 | * [`tools.refinery:refinery-language-model`](pathname://refinery-language-model) | ||
19 | * [`tools.refinery:refinery-language-semantics`](pathname://refinery-language-semantics) | ||
20 | * [`tools.refinery:refinery-language-web`](pathname://refinery-language-web) | ||
21 | * [`tools.refinery:refinery-logic`](pathname://refinery-logic) | ||
22 | * [`tools.refinery:refinery-store`](pathname://refinery-store) | ||
23 | * [`tools.refinery:refinery-store-dse`](pathname://refinery-store-dse) | ||
24 | * [`tools.refinery:refinery-store-dse-visualization`](pathname://refinery-store-dse-visualization) | ||
25 | * [`tools.refinery:refinery-store-query`](pathname://refinery-store-query) | ||
26 | * [`tools.refinery:refinery-store-query-interpreter`](pathname://refinery-store-query-interpreter) | ||
27 | * [`tools.refinery:refinery-store-reasoning`](pathname://refinery-store-reasoning) | ||
28 | * [`tools.refinery:refinery-store-reasoning-scope`](pathname://refinery-store-reasoning-scope) | ||
29 | * [`tools.refinery:refinery-store-reasoning-smt`](pathname://refinery-store-reasoning-smt) | ||
30 | |||
31 | # Interpreter | ||
32 | |||
33 | :::note | ||
34 | |||
35 | The _Refinery Interpreter_ is modified version of [VIATRA™](https://eclipse.dev/viatra/) specifically for use in Refinery. If you're interested in learning about [VIATRA™](https://eclipse.dev/viatra/), we recommend the [VIATRA™ documentation](https://eclipse.dev/viatra/documentation/index.html) and [source code](https://github.com/eclipse-viatra/org.eclipse.viatra) instead. Eclipse®, VIATRA™ and ‘Eclipse VIATRA™’ are trademarks of Eclipse Foundation, Inc. | ||
36 | |||
37 | ::: | ||
38 | |||
39 | * [`tools.refinery.interpreter:refinery-interpreter`](pathname://refinery-interpreter) | ||
40 | * [`tools.refinery.interpreter:refinery-interpreter-localsearch`](pathname://refinery-interpreter-localsearch) | ||
41 | * [`tools.refinery.interpreter:refinery-interpreter-rete`](pathname://refinery-interpreter-rete) | ||
42 | * [`tools.refinery.interpreter:refinery-interpreter-rete-recipes`](pathname://refinery-interpreter-rete-recipes) | ||