Skip to content

Commit 0078709

Browse files
committed
docs: refine model-api docs
1 parent ccb6232 commit 0078709

File tree

3 files changed

+24
-11
lines changed

3 files changed

+24
-11
lines changed

docs/global/modules/core/pages/reference/component-metamodel-export.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ https://github.com/modelix/modelix.core[Repository^] | https://github.com/modeli
1111

1212
In order to export a meta-model (i.e. the structure aspect of a langauge) from MPS, modelix uses the MPS solution `metamodel-export`.
1313
This solution maps the structure of a language to corresponding serializable data classes of the https://api.modelix.org/2.3.0/model-api/org.modelix.model.data/index.html[`model-api`] (e.g. `LanguageData` and `ConcepData`).
14-
Further, the `metamodel-expor` provides a command line interface to export these data classes to a JSON file from outside of MPS.
14+
Further, the `metamodel-export` provides a command line interface to export these data classes to a JSON file from outside of MPS.
1515

1616

1717

docs/global/modules/core/pages/reference/component-model-api-gen-gradle.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
= Gradle Plugin for the Model API Generator
22
:navtitle: `model-api-gen-gradle`
33

4-
54
:tip-caption: 🔗 Quick Links
65
[TIP]
76
--

docs/global/modules/core/pages/reference/component-model-api.adoc

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,20 @@
55
:tip-caption: 🔗 Quick Links
66
[TIP]
77
--
8-
https://api.modelix.org/2.3.0/model-api/index.html[API doc^] | https://github.com/modelix/modelix.core[Repository^] | Artifacts: https://artifacts.itemis.cloud/service/rest/repository/browse/maven-mps/org/modelix/model-api/[Nexus^] https://github.com/modelix/modelix.core/packages/1834768[GitHub Packages^]
8+
https://api.modelix.org/2.3.0/model-api/index.html[API doc^] | https://github.com/modelix/modelix.core[Repository^] | https://github.com/modelix/modelix.core/blob/main/model-api/build.gradle.kts[buildfile^]
99
--
1010

11+
:tip-caption: 🔗 Artifacts
12+
[TIP]
13+
--
14+
`org.modelix.model-api`: https://artifacts.itemis.cloud/service/rest/repository/browse/maven-mps/org/modelix/model-api/[Nexus^] https://github.com/modelix/modelix.core/packages/1834768[GitHub Packages^]
15+
16+
// TODO `org.modelix.model-api-jvm`:
17+
18+
// TODO `org.modelix.model-api-js`:
19+
--
20+
21+
1122
== Overview
1223

1324
The *Model API* (`model-api`) is a Kotlin component which provides a metamodel independent model API.
@@ -21,25 +32,28 @@ The `model-api` provides three distinct parts
2132
3. `org.modelix.model.area`: Model grouping and transactional access
2233

2334

24-
=== `org.modelix.model.api`
35+
=== 1. `org.modelix.model.api`
2536

2637
The following diagram provides a meta-model of the `model-api`
2738

2839
image::model-api.api.png[]
2940

30-
Using the `model-api` an **untyped** access to model content is always possible.
31-
In case you want to use domain-specific model access, the xref:core:reference/component-model-api-gen.adoc[model-api-gen] provides a generator which generates a typed model API specializes the API provided by the `model-api`.
41+
An **untyped** access to model content is possible when only using the `model-api`.
42+
In case you want to use domain-specific model access (i.e. **typed** access), the xref:core:reference/component-model-api-gen.adoc[model-api-gen] provides a generator which generates a typed model API from your existing meta-model.
43+
This generated API specializes the `model-api`.
3244

3345

34-
=== `org.modelix.model.data`
46+
=== 2.`org.modelix.model.data`
3547

3648
Additionally, the `model-api` provides serializable data classes to represent a meta-model.
3749
The following diagrams show a class diagram of the data classes for the model and meta-model.
3850

39-
image::model-api.data.model.png[]
40-
41-
image::model-api.data.metamodel.png[]
51+
[cols="a,a", frame=none, grid=none]
52+
|===
53+
| image::model-api.data.model.png[width=69%]
54+
| image::model-api.data.metamodel.png[]
55+
|===
4256

4357

44-
//=== === `org.modelix.model.area`
58+
//=== 3. `org.modelix.model.area`
4559
//TODO

0 commit comments

Comments
 (0)