Skip to content

Commit

Permalink
Merge pull request #3235 from eclipse/cd-regen-docs-2024-12
Browse files Browse the repository at this point in the history
regenerate docs
  • Loading branch information
cdietrich authored Nov 5, 2024
2 parents 8321a58 + d746128 commit e8f97ca
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 11 deletions.
4 changes: 2 additions & 2 deletions org.eclipse.xtend.doc/contents/204_activeannotations.html
Original file line number Diff line number Diff line change
Expand Up @@ -238,13 +238,13 @@ <h2 id="active-annotation-classpath">Class Path Setup and Testing</h2>
<pre><code>&lt;dependency&gt;
&lt;groupId&gt;org.eclipse.xtend&lt;/groupId&gt;
&lt;artifactId&gt;org.eclipse.xtend.core&lt;/artifactId&gt;
&lt;version&gt;2.35.0&lt;/version&gt;
&lt;version&gt;2.37.0&lt;/version&gt;
&lt;scope&gt;test&lt;/scope&gt;
&lt;/dependency&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.eclipse.xtext&lt;/groupId&gt;
&lt;artifactId&gt;org.eclipse.xtext.xbase.testing&lt;/artifactId&gt;
&lt;version&gt;2.35.0&lt;/version&gt;
&lt;version&gt;2.37.0&lt;/version&gt;
&lt;scope&gt;test&lt;/scope&gt;
&lt;/dependency&gt;
</code></pre>
Expand Down
8 changes: 4 additions & 4 deletions org.eclipse.xtext.doc/contents/305_xbase.html
Original file line number Diff line number Diff line change
Expand Up @@ -224,12 +224,12 @@ <h3 id="linking-and-indexing">Linking and Indexing</h3>

<h3 id="validation">Validation</h3>

<p>Besides your custom validations, you can use <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.xbase/src/org/eclipse/xtext/xbase/validation/JvmGenericTypeValidator.java">JvmGenericTypeValidator</a>, introduced in version 2.35.0. This automatically perform several Java-related checks in the hierarchy of the inferred <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.common.types/emf-gen/org/eclipse/xtext/common/types/JvmGenericType.java">JvmGenericType</a>s of an Xbase language, with the corresponding error reporting.
<p>Besides your custom validations, you can use <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.xbase/src/org/eclipse/xtext/xbase/validation/JvmGenericTypeValidator.java">JvmGenericTypeValidator</a>, introduced in version 2.35.0. This automatically perform several Java-related checks in the hierarchy of the inferred <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.common.types/emf-gen/org/eclipse/xtext/common/types/JvmGenericType.java">JvmGenericType</a>s of an Xbase language, with the corresponding error reporting.<br />
For example, cycles in a hierarchy, extension of a final class, proper extension of an abstract class (do you implement all the abstract methods or declare the inferred class as abstract?), proper method overriding, etc. It also performs duplicate elements checks, like duplicate parameter names, duplicate fields and duplicate methods (keeping the type-erasure into consideration when using types with arguments).</p>

<p>This mechanism assumes that you implement the <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.xbase/src/org/eclipse/xtext/xbase/jvmmodel/IJvmModelInferrer.java">IJvmModelInferrer</a> “correctly”.
It only checks the first inferred <code>JvmGenericType</code> for the same DSL element (i.e., if for an element <code>Entity</code> you infer two <code>JvmGenericType</code>s, <code>t1</code> and <code>t2</code>, only the first one will be checked).
Moreover, it only checks Jvm model elements with an associated source element.
<p>This mechanism assumes that you implement the <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.xbase/src/org/eclipse/xtext/xbase/jvmmodel/IJvmModelInferrer.java">IJvmModelInferrer</a> “correctly”.<br />
It only checks the first inferred <code>JvmGenericType</code> for the same DSL element (i.e., if for an element <code>Entity</code> you infer two <code>JvmGenericType</code>s, <code>t1</code> and <code>t2</code>, only the first one will be checked).<br />
Moreover, it only checks Jvm model elements with an associated source element.<br />
Concerning intended classes to extend and interfaces to extend/implement, it assumes the model inferrer uses the <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.xbase/src/org/eclipse/xtext/xbase/jvmmodel/JvmTypesBuilder.java">JvmTypesBuilder</a> methods <code>setSuperClass(JvmDeclaredType, JvmTypeReference)</code> and <code>addSuperInterface(JvmDeclaredType, JvmTypeReference)</code>, respectively.</p>

<p>Currently, this validator must be enabled explicitly through the <code>composedCheck</code> in the MWE2 file or the <code>@ComposedChecks</code> annotation in the validator, e.g., <code>@ComposedChecks(validators = JvmGenericTypeValidator.class)</code>.</p>
Expand Down
4 changes: 2 additions & 2 deletions org.eclipse.xtext.doc/contents/310_eclipse_support.html
Original file line number Diff line number Diff line change
Expand Up @@ -551,9 +551,9 @@ <h3 id="location-provider">Location Provider</h3>

<p>The location service offers different methods to obtain the region of interest for special use cases. You can either obtain the complete region for an object or only the identifying string which is usually the name of the instance (see <code>getSignificantTextRegion(EObject)</code>). You can also query for the text region of a specific <a href="https://git.eclipse.org/r/plugins/gitiles/emf/org.eclipse.emf/+/refs/tags/R2_20_0/plugins/org.eclipse.emf.ecore/src/org/eclipse/emf/ecore/EStructuralFeature.java">EStructuralFeature</a> by means of <code>getFullTextRegion(EObject, EStructuralFeature, int)</code>.</p>

<p>As the default strategy is a best effort it may not always result in the selection you want. If that’s the case you can <a href="302_configuration.html#guicemodules">override</a> the <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext/src/org/eclipse/xtext/resource/ILocationInFileProvider.java">ILocationInFileProvider</a> binding in the UI module as in the following example:</p>
<p>As the default strategy is a best effort it may not always result in the selection you want. If that’s the case you can <a href="302_configuration.html#guicemodules">override</a> the <a href="https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext/src/org/eclipse/xtext/resource/ILocationInFileProvider.java">ILocationInFileProvider</a> binding in the runtime module as in the following example:</p>

<pre><code class="language-java">public class MyDslUiModule extends AbstractMyDslUiModule {
<pre><code class="language-java">public class MyDslRuntimeModule extends AbstractMyDslRuntimeModule {
@Override
public Class&lt;? extends ILocationInFileProvider&gt;
bindILocationInFileProvider() {
Expand Down
2 changes: 2 additions & 0 deletions org.eclipse.xtext.doc/contents/340_lsp_support.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ <h2 id="getting-started-eclipse">Getting Started in Eclipse</h2>
"uuid": "8383e49a-fa0d-4bb5-827b-10e8abb294ca"
}
</code></pre>
<p>You may save the content in a file and then add it to the TextMate grammar in Preferences.<br />
<img src="images/LSP_04B_AddTextMateGrammarFile.png" alt="Domainmodel Language Server Launcher" /></p>
</li>
<li>Open a <code>*.dmodel</code> file with the Generic Editor and explore the supported language features like syntax highlighting, content assist, validation, displaying code lenses, quickfixes, formatting, … :<br />
<img src="images/LSP_05_DomainmodelLanguageFeatures.png" alt="Domainmodel Language Features" /></li>
Expand Down
22 changes: 19 additions & 3 deletions org.eclipse.xtext.doc/contents/350_continuous_integration.html
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,22 @@ <h2 id="maven-tycho-hints">Maven Tycho Hints</h2>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://download.eclipse.org/modeling/tmf/xtext/updates/releases/2.37.0/">2.37.0</a></td>
<td><a href="https://download.eclipse.org/modeling/emf/emf/builds/release/2.39.0">2.39.0</a> (2.29.0)</td>
<td><a href="https://download.eclipse.org/modeling/emft/mwe/updates/releases/2.20.0/">2.20.0</a> (2.9.1)</td>
<td>no longer supported</td>
<td><a href="https://download.eclipse.org/releases/2024-12">4.34.0</a> (4.24)</td>
<td><a href="https://download.eclipse.org/releases/2024-12">2024-12</a></td>
</tr>
<tr>
<td><a href="https://download.eclipse.org/modeling/tmf/xtext/updates/releases/2.36.0/">2.36.0</a></td>
<td><a href="https://download.eclipse.org/modeling/emf/emf/builds/release/2.38.0">2.38.0</a> (2.29.0)</td>
<td><a href="https://download.eclipse.org/modeling/emft/mwe/updates/releases/2.19.0/">2.19.0</a> (2.9.1)</td>
<td>no longer supported</td>
<td><a href="https://download.eclipse.org/releases/2024-09">4.33.0</a> (4.23)</td>
<td><a href="https://download.eclipse.org/releases/2024-09">2024-09</a></td>
</tr>
<tr>
<td><a href="https://download.eclipse.org/modeling/tmf/xtext/updates/releases/2.35.0/">2.35.0</a></td>
<td><a href="https://download.eclipse.org/modeling/emf/emf/builds/release/2.38.0">2.38.0</a> (2.29.0)</td>
Expand Down Expand Up @@ -556,15 +572,15 @@ <h2 id="maven-tycho-hints">Maven Tycho Hints</h2>
</tbody>
</table>

<p>The following is an example target platform definition for Xtext 2.35.0 and Eclipse 4.32 alias 2024-06.</p>
<p>The following is an example target platform definition for Xtext 2.37.0 and Eclipse 4.34 alias 2024-12.</p>

<pre><code class="language-xml">&lt;?xml version="1.0" encoding="UTF-8" standalone="no"?&gt;
&lt;?pde version="3.8"?&gt;
&lt;target name="org.xtext.myxtextlanguage.target" sequenceNumber="1"&gt;
&lt;locations&gt;
&lt;location includeAllPlatforms="false" includeConfigurePhase="false" includeMode="planner" includeSource="false" type="InstallableUnit"&gt;
&lt;unit id="org.eclipse.xtext.sdk.feature.group" version="0.0.0"/&gt;
&lt;repository location="https://download.eclipse.org/modeling/tmf/xtext/updates/releases/2.35.0/"/&gt;
&lt;repository location="https://download.eclipse.org/modeling/tmf/xtext/updates/releases/2.37.0/"/&gt;
&lt;/location&gt;
&lt;location includeAllPlatforms="false" includeConfigurePhase="false" includeMode="planner" includeSource="false" type="InstallableUnit"&gt;
&lt;unit id="org.eclipse.jdt.feature.group" version="0.0.0"/&gt;
Expand All @@ -573,7 +589,7 @@ <h2 id="maven-tycho-hints">Maven Tycho Hints</h2>
&lt;unit id="org.eclipse.draw2d.feature.group" version="0.0.0"/&gt;
&lt;unit id="org.eclipse.emf.sdk.feature.group" version="0.0.0"/&gt;
&lt;unit id="org.eclipse.emf.mwe2.launcher.feature.group" version="0.0.0"/&gt;
&lt;repository location="https://download.eclipse.org/releases/2024-06/"/&gt;
&lt;repository location="https://download.eclipse.org/releases/2024-12/"/&gt;
&lt;/location&gt;
&lt;/locations&gt;
&lt;/target&gt;
Expand Down

0 comments on commit e8f97ca

Please sign in to comment.