fixed some javadocs

Signed-off-by: Christian Dietrich <christian.dietrich@itemis.de>
This commit is contained in:
Christian Dietrich 2019-02-10 22:01:00 +01:00
parent 882165995c
commit dfe72b83c0
10 changed files with 17 additions and 12 deletions

View file

@ -113,7 +113,7 @@ class SemanticHighlightingRegistry {
/**
* Returns with the internal scope index for the argument. Returns {@code -1} if the scopes
* argument is {@null}, the {@link SemanticHighlightingRegistry#UNKNOWN_SCOPES unknown scopes}
* argument is <code>null</code>, the {@link SemanticHighlightingRegistry#UNKNOWN_SCOPES unknown scopes}
* or is not registered to this manager.
*/
def int getIndex(List<String> scopes) {

View file

@ -198,7 +198,7 @@ public class SemanticHighlightingRegistry {
/**
* Returns with the internal scope index for the argument. Returns {@code -1} if the scopes
* argument is {@null}, the {@link SemanticHighlightingRegistry#UNKNOWN_SCOPES unknown scopes}
* argument is <code>null</code>, the {@link SemanticHighlightingRegistry#UNKNOWN_SCOPES unknown scopes}
* or is not registered to this manager.
*/
public int getIndex(final List<String> scopes) {

View file

@ -32,7 +32,7 @@ public @interface RepeatedTest {
int times() default 10;
/**
* Test rule used along with {@link RepeatTest} to let a test loop for a couple
* Test rule used along with {@link RepeatedTest} to let a test loop for a couple
* of rounds.
*/
public static class Rule implements TestRule {

View file

@ -1,10 +1,11 @@
package org.eclipse.xtext.generator
import com.google.common.annotations.Beta
import java.util.concurrent.BlockingQueue
import org.eclipse.core.runtime.IProgressMonitor
import org.eclipse.core.runtime.OperationCanceledException
import org.eclipse.emf.common.notify.impl.AdapterImpl
import org.eclipse.emf.common.util.URI
import org.eclipse.core.runtime.IProgressMonitor
import org.eclipse.xtend.lib.annotations.FinalFieldsConstructor
/**
@ -43,8 +44,8 @@ class FileSystemAccessQueue extends AdapterImpl {
/**
* @since 2.14
* @beta
*/
@Beta
def void waitForEmptyQueue() {
while (!requestQueue.isEmpty) {
Thread.yield

View file

@ -123,7 +123,7 @@ class GeneratorNodeProcessor {
}
/**
* @returns a copy of current indent nodes
* @return a copy of current indent nodes
*/
def Deque<IndentNode> getCurrentIndents() {
new ArrayDeque(_currentIndents)

View file

@ -29,6 +29,7 @@ import org.eclipse.xtext.serializer.analysis.SerializationContext;
import org.eclipse.xtext.serializer.diagnostic.ISerializationDiagnostic;
import org.eclipse.xtext.serializer.diagnostic.ISerializationDiagnostic.Acceptor;
import org.eclipse.xtext.serializer.sequencer.ISemanticSequencer;
import org.eclipse.xtext.serializer.sequencer.ISemanticNodeProvider;
import org.eclipse.xtext.serializer.sequencer.ISemanticNodeProvider.INodesForEObjectProvider;
import org.eclipse.xtext.serializer.tokens.ICrossReferenceSerializer;
import org.eclipse.xtext.serializer.tokens.IEnumLiteralSerializer;
@ -56,7 +57,7 @@ public class SequenceFeeder {
protected IValueSerializer valueSerializer;
/**
* @deprecated {@link #create(ISerializationContext, EObject, INodesForEObjectProvider, ISemanticSequencer, ISemanticSequenceAcceptor, Acceptor)}
* @deprecated {@link #create(ISerializationContext, EObject, ISemanticNodeProvider.INodesForEObjectProvider, ISemanticSequencer, ISemanticSequenceAcceptor, ISerializationDiagnostic.Acceptor)}
*/
@Deprecated
public SequenceFeeder create(EObject semanticObject, INodesForEObjectProvider nodes, ISemanticSequencer masterSequencer,
@ -85,7 +86,7 @@ public class SequenceFeeder {
protected final ISerializationContext context;
/**
* @deprecated {@link #SequenceFeeder(Provider, ISerializationContext, EObject, INodesForEObjectProvider, ISemanticSequencer, ISemanticSequenceAcceptor, Acceptor)}
* @deprecated {@link #SequenceFeeder(SequenceFeeder.Provider, ISerializationContext, EObject, ISemanticNodeProvider.INodesForEObjectProvider, ISemanticSequencer, ISemanticSequenceAcceptor, ISerializationDiagnostic.Acceptor)}
*/
@Deprecated
protected SequenceFeeder(Provider provider, EObject semanticObject, INodesForEObjectProvider nodes, ISemanticSequencer masterSequencer,

View file

@ -10,6 +10,7 @@ package org.eclipse.xtext.serializer.diagnostic;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.xtext.serializer.ISerializationContext;
import org.eclipse.xtext.serializer.analysis.IGrammarConstraintProvider;
import org.eclipse.xtext.serializer.analysis.IGrammarConstraintProvider.IConstraint;
import org.eclipse.xtext.serializer.analysis.ISemanticSequencerNfaProvider.ISemState;
import org.eclipse.xtext.serializer.sequencer.BacktrackingSemanticSequencer.SerializableObject;
@ -38,7 +39,7 @@ public interface ISemanticSequencerDiagnosticProvider {
ISerializationDiagnostic createFeatureValueMissing(EObject semanticObject, EStructuralFeature feature);
/**
* @deprecated use {@link #createBacktrackingFailedDiagnostic(SerializableObject, ISerializationContext, IConstraint)}
* @deprecated use {@link #createBacktrackingFailedDiagnostic(BacktrackingSemanticSequencer.SerializableObject, ISerializationContext, IGrammarConstraintProvider.IConstraint)}
*/
@Deprecated
ISerializationDiagnostic createBacktrackingFailedDiagnostic(SerializableObject semanticObject, EObject context,

View file

@ -11,6 +11,7 @@ import org.eclipse.emf.ecore.EObject;
import org.eclipse.xtext.AbstractElement;
import org.eclipse.xtext.RuleCall;
import org.eclipse.xtext.serializer.ISerializationContext;
import org.eclipse.xtext.serializer.analysis.ISyntacticSequencerPDAProvider;
import org.eclipse.xtext.serializer.analysis.ISyntacticSequencerPDAProvider.ISynAbsorberState;
import org.eclipse.xtext.serializer.analysis.ISyntacticSequencerPDAProvider.ISynNavigable;
import org.eclipse.xtext.serializer.analysis.ISyntacticSequencerPDAProvider.ISynState;
@ -30,7 +31,7 @@ public interface ISyntacticSequencerDiagnosticProvider {
String UNEXPECTED_EMITTER_DIAGNOSTIC = "unexepcted emitter diagnostic";
/**
* @deprecated {@link #createInvalidFollowingAbsorberDiagnostic(ISerializationContext, EObject, ISynAbsorberState, AbstractElement)}
* @deprecated {@link #createInvalidFollowingAbsorberDiagnostic(ISerializationContext, EObject, ISyntacticSequencerPDAProvider.ISynAbsorberState, AbstractElement)}
*/
@Deprecated
ISerializationDiagnostic createInvalidFollowingAbsorberDiagnostic(EObject context, EObject semanticObject,

View file

@ -1,5 +1,6 @@
package org.eclipse.xtext.generator;
import com.google.common.annotations.Beta;
import java.util.concurrent.BlockingQueue;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
@ -56,8 +57,8 @@ public class FileSystemAccessQueue extends AdapterImpl {
/**
* @since 2.14
* @beta
*/
@Beta
public void waitForEmptyQueue() {
while ((!this.requestQueue.isEmpty())) {
Thread.yield();

View file

@ -226,7 +226,7 @@ public class GeneratorNodeProcessor {
}
/**
* @returns a copy of current indent nodes
* @return a copy of current indent nodes
*/
public Deque<IndentNode> getCurrentIndents() {
return new ArrayDeque<IndentNode>(this._currentIndents);