summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Kristóf Marussy <kristof@marussy.com>2024-07-11 01:20:54 +0200
committerLibravatar Kristóf Marussy <kristof@marussy.com>2024-07-11 01:37:49 +0200
commit8b22297a2b53dac1c3f6abdbc4573422aa453b3a (patch)
tree30550597baef74bde2331850169611d9eff73974
parenttest(web): try to make integration tests less flaky (diff)
downloadrefinery-8b22297a2b53dac1c3f6abdbc4573422aa453b3a.tar.gz
refinery-8b22297a2b53dac1c3f6abdbc4573422aa453b3a.tar.zst
refinery-8b22297a2b53dac1c3f6abdbc4573422aa453b3a.zip
Add refinery-gradle-plugins javadocs.
-rw-r--r--subprojects/docs/build.gradle.kts2
-rw-r--r--subprojects/docs/src/css/custom.css10
-rw-r--r--subprojects/docs/src/develop/javadoc.md37
-rw-r--r--subprojects/docs/src/learn/index.md2
-rw-r--r--subprojects/docs/src/learn/language/classes/index.md7
-rw-r--r--subprojects/docs/src/plugins/remarkPosix2Windows.ts4
6 files changed, 35 insertions, 27 deletions
diff --git a/subprojects/docs/build.gradle.kts b/subprojects/docs/build.gradle.kts
index ab67128a..8ea64348 100644
--- a/subprojects/docs/build.gradle.kts
+++ b/subprojects/docs/build.gradle.kts
@@ -30,6 +30,8 @@ dependencies {
30 } 30 }
31 } 31 }
32 } 32 }
33
34 javadocs(project(":refinery-gradle-plugins", "javadocElements"))
33} 35}
34 36
35val srcDir = "src" 37val srcDir = "src"
diff --git a/subprojects/docs/src/css/custom.css b/subprojects/docs/src/css/custom.css
index 146b45a0..64eeb5c4 100644
--- a/subprojects/docs/src/css/custom.css
+++ b/subprojects/docs/src/css/custom.css
@@ -80,14 +80,18 @@ code {
80 --ifm-navbar-shadow: var(--ifm-global-shadow-lw) !important; 80 --ifm-navbar-shadow: var(--ifm-global-shadow-lw) !important;
81} 81}
82 82
83.button, .navbar__link, .footer__link-item, .DocSearch-Button-Placeholder { 83.button, .navbar__link, .footer__link-item {
84 text-transform: uppercase; 84 text-transform: uppercase;
85 font-variation-settings: 'wdth' 87.5; 85 font-variation-settings: 'wdth' 87.5;
86} 86}
87 87
88.DocSearch-Button-Placeholder { 88.DocSearch-Button-Placeholder {
89 padding: 0 9px 0 6px !important; 89 font-family: var(--ifm-font-family-base) !important;
90 font-family: var(--ifm-font-family-base); 90}
91
92.button {
93 /* No decoration even in `::: info` boxes. */
94 text-decoration: none;
91} 95}
92 96
93.button--play::before { 97.button--play::before {
diff --git a/subprojects/docs/src/develop/javadoc.md b/subprojects/docs/src/develop/javadoc.md
index e94e3eab..be2ed0e3 100644
--- a/subprojects/docs/src/develop/javadoc.md
+++ b/subprojects/docs/src/develop/javadoc.md
@@ -11,20 +11,21 @@ Here you can find API documentation for Refinery components automatically genera
11 11
12# Refinery 12# Refinery
13 13
14* [`tools.refinery:refinery-generator`](pathname://refinery-generator) 14* [`tools.refinery:refinery-generator`](pathname://refinery-generator/)
15* [`tools.refinery:refinery-language`](pathname://refinery-language) 15* [`tools.refinery:refinery-gradle-plugins`](pathname://refinery-gradle-plugins/)
16* [`tools.refinery:refinery-language-ide`](pathname://refinery-language-ide) 16* [`tools.refinery:refinery-language`](pathname://refinery-language/)
17* [`tools.refinery:refinery-language-model`](pathname://refinery-language-model) 17* [`tools.refinery:refinery-language-ide`](pathname://refinery-language-ide/)
18* [`tools.refinery:refinery-language-semantics`](pathname://refinery-language-semantics) 18* [`tools.refinery:refinery-language-model`](pathname://refinery-language-model/)
19* [`tools.refinery:refinery-logic`](pathname://refinery-logic) 19* [`tools.refinery:refinery-language-semantics`](pathname://refinery-language-semantics/)
20* [`tools.refinery:refinery-store`](pathname://refinery-store) 20* [`tools.refinery:refinery-logic`](pathname://refinery-logic/)
21* [`tools.refinery:refinery-store-dse`](pathname://refinery-store-dse) 21* [`tools.refinery:refinery-store`](pathname://refinery-store/)
22* [`tools.refinery:refinery-store-dse-visualization`](pathname://refinery-store-dse-visualization) 22* [`tools.refinery:refinery-store-dse`](pathname://refinery-store-dse/)
23* [`tools.refinery:refinery-store-query`](pathname://refinery-store-query) 23* [`tools.refinery:refinery-store-dse-visualization`](pathname://refinery-store-dse-visualization/)
24* [`tools.refinery:refinery-store-query-interpreter`](pathname://refinery-store-query-interpreter) 24* [`tools.refinery:refinery-store-query`](pathname://refinery-store-query/)
25* [`tools.refinery:refinery-store-reasoning`](pathname://refinery-store-reasoning) 25* [`tools.refinery:refinery-store-query-interpreter`](pathname://refinery-store-query-interpreter/)
26* [`tools.refinery:refinery-store-reasoning-scope`](pathname://refinery-store-reasoning-scope) 26* [`tools.refinery:refinery-store-reasoning`](pathname://refinery-store-reasoning/)
27* [`tools.refinery:refinery-store-reasoning-smt`](pathname://refinery-store-reasoning-smt) 27* [`tools.refinery:refinery-store-reasoning-scope`](pathname://refinery-store-reasoning-scope/)
28* [`tools.refinery:refinery-store-reasoning-smt`](pathname://refinery-store-reasoning-smt/)
28 29
29# Interpreter 30# Interpreter
30 31
@@ -34,7 +35,7 @@ The _Refinery Interpreter_ is modified version of [VIATRA&trade;](https://eclips
34 35
35::: 36:::
36 37
37* [`tools.refinery.interpreter:refinery-interpreter`](pathname://refinery-interpreter) 38* [`tools.refinery.interpreter:refinery-interpreter`](pathname://refinery-interpreter/)
38* [`tools.refinery.interpreter:refinery-interpreter-localsearch`](pathname://refinery-interpreter-localsearch) 39* [`tools.refinery.interpreter:refinery-interpreter-localsearch`](pathname://refinery-interpreter-localsearch/)
39* [`tools.refinery.interpreter:refinery-interpreter-rete`](pathname://refinery-interpreter-rete) 40* [`tools.refinery.interpreter:refinery-interpreter-rete`](pathname://refinery-interpreter-rete/)
40* [`tools.refinery.interpreter:refinery-interpreter-rete-recipes`](pathname://refinery-interpreter-rete-recipes) 41* [`tools.refinery.interpreter:refinery-interpreter-rete-recipes`](pathname://refinery-interpreter-rete-recipes/)
diff --git a/subprojects/docs/src/learn/index.md b/subprojects/docs/src/learn/index.md
index bb28df57..7f67fd86 100644
--- a/subprojects/docs/src/learn/index.md
+++ b/subprojects/docs/src/learn/index.md
@@ -8,4 +8,4 @@ sidebar_position: 0
8 8
9Various software and systems engineering scenarios rely on the systematic construction of consistent graph models. However, **automatically generating a diverse set of consistent graph models** for complex domain specifications is challenging. First, the graph generation problem must be specified with mathematical precision. Moreover, graph generation is a computationally complex task, which necessitates specialized logic solvers. 9Various software and systems engineering scenarios rely on the systematic construction of consistent graph models. However, **automatically generating a diverse set of consistent graph models** for complex domain specifications is challenging. First, the graph generation problem must be specified with mathematical precision. Moreover, graph generation is a computationally complex task, which necessitates specialized logic solvers.
10 10
11**Refinery is a novel open-source software framework** to automatically synthesize a diverse set of consistent domain-specific graph models. The framework offers an expressive high-level specification language using partial models to succinctly formulate a wide range of graph generation challenges. It also provides a modern cloud-based architecture for a scalable _Graph Solver as a Service,_ which uses logic reasoning rules to efficiently synthesize a diverse set of solutions to graph generation problems by partial model refinement. Applications include system-level architecture synthesis, test generation for modeling tools or traffic scenario synthesis for autonomous vehicles. 11**Refinery is an open-source software framework** for the automated synthesis of a diverse set of consistent domain-specific graph models. The framework offers an expressive high-level specification language using partial models to succinctly formulate a wide range of graph generation challenges. It also provides a modern cloud-based architecture for a scalable _Graph Solver as a Service,_ which uses logic reasoning rules to efficiently synthesize a diverse set of solutions to graph generation problems by partial model refinement. Applications include system-level architecture synthesis, test generation for modeling tools or traffic scenario synthesis for autonomous vehicles.
diff --git a/subprojects/docs/src/learn/language/classes/index.md b/subprojects/docs/src/learn/language/classes/index.md
index 73108039..18cbbf9f 100644
--- a/subprojects/docs/src/learn/language/classes/index.md
+++ b/subprojects/docs/src/learn/language/classes/index.md
@@ -129,7 +129,7 @@ import ReferencesOppositeSelf from './ReferencesOppositeSelf.svg';
129 129
130### Multiplicity 130### Multiplicity
131 131
132_Multiplicity constrains_ can be provided after the reference type in square braces. 132_Multiplicity constraints_ can be provided after the reference type in square braces.
133They specify how many _outgoing_ references should exist for any given instance of the class. 133They specify how many _outgoing_ references should exist for any given instance of the class.
134 134
135:::info 135:::info
@@ -150,7 +150,7 @@ If the multiplicity constraint is omitted, the bound `[0..1]` is assumed.
150 150
151In the following model, the node `v1` satisfies all multiplicity constraints of `outgoingTransition`. 151In the following model, the node `v1` satisfies all multiplicity constraints of `outgoingTransition`.
152The node `v2` violates the lower bound constraint, while `v3` violates the upper bound constraint. 152The node `v2` violates the lower bound constraint, while `v3` violates the upper bound constraint.
153All `Transition` instances satisfy the multiplicity constrains associated with `source`. 153All `Transition` instances satisfy the multiplicity constraints associated with `source`.
154 154
155```refinery 155```refinery
156class Vertex { 156class Vertex {
@@ -209,4 +209,5 @@ import ContainmentInstance from './ContainmentInstance.svg';
209 209
210<ContainmentInstance /> 210<ContainmentInstance />
211 211
212Containment edges form trees, while non-containment references, such as `target`, may point across the containment hierarchy. 212Containment edges form must form a forest.
213In contrast, non-containment references, such as `target`, may cross the containment hierarchy.
diff --git a/subprojects/docs/src/plugins/remarkPosix2Windows.ts b/subprojects/docs/src/plugins/remarkPosix2Windows.ts
index 784802f2..77156e81 100644
--- a/subprojects/docs/src/plugins/remarkPosix2Windows.ts
+++ b/subprojects/docs/src/plugins/remarkPosix2Windows.ts
@@ -2,11 +2,11 @@
2 * Copyright (c) Facebook, Inc. and its affiliates. 2 * Copyright (c) Facebook, Inc. and its affiliates.
3 * Copyright (c) 2024 The Refinery Authors 3 * Copyright (c) 2024 The Refinery Authors
4 * 4 *
5 * SPDX-License-Identifier: EPL-2.0 5 * SPDX-License-Identifier: MIT AND EPL-2.0
6 * 6 *
7 * This file is based on 7 * This file is based on
8 * https://github.com/facebook/docusaurus/blob/e4ecffe41878728acff55a8370bd7440706c02f7/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts 8 * https://github.com/facebook/docusaurus/blob/e4ecffe41878728acff55a8370bd7440706c02f7/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts
9 * but was changed to conver shell commands to POSIX to Windows syntax. 9 * but was changed to convert shell commands to POSIX to Windows syntax.
10 */ 10 */
11 11
12import type { Code, Literal } from 'mdast'; 12import type { Code, Literal } from 'mdast';