From 3a740a437e197ec8aa8a05554821af6f6c0bc6e3 Mon Sep 17 00:00:00 2001 From: Florian Stolte Date: Tue, 19 Dec 2017 11:47:58 +0100 Subject: [PATCH] [eclipse/xtext#1155] Cleaned up javadoc to remove some warnings. Signed-off-by: Florian Stolte --- .../ide/refactoring/IResourceRelocationStrategy.xtend | 2 +- .../ide/refactoring/ResourceRelocationContext.xtend | 2 +- .../xtext/ide/serializer/IChangeSerializer.java | 2 +- .../ide/refactoring/IResourceRelocationStrategy.java | 2 +- .../ide/refactoring/ResourceRelocationContext.java | 2 +- .../xtext/xtext/generator/XtextGeneratorLanguage.xtend | 2 +- .../xtext/xtext/generator/XtextGeneratorLanguage.java | 2 +- .../org/eclipse/xtext/conversion/IValueConverter.java | 6 ++++-- .../eclipse/xtext/resource/IResourceDescription.java | 10 +++++----- 9 files changed, 16 insertions(+), 14 deletions(-) diff --git a/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/refactoring/IResourceRelocationStrategy.xtend b/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/refactoring/IResourceRelocationStrategy.xtend index 9dfcc5ce9..307efd6e4 100644 --- a/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/refactoring/IResourceRelocationStrategy.xtend +++ b/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/refactoring/IResourceRelocationStrategy.xtend @@ -15,7 +15,7 @@ package org.eclipse.xtext.ide.refactoring * would make sense is Java, where the package name and the name of the first * public top-level class must match the resource's path. * - * Clients usually call {@link ResourceRelocationContext.addModification()} to + * Clients usually call {@link ResourceRelocationContext#addModification} to * register their side effects. This way it is ensured that the resource is * properly loaded and watched for changes. * diff --git a/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/refactoring/ResourceRelocationContext.xtend b/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/refactoring/ResourceRelocationContext.xtend index 7279120c6..8e7327bc3 100644 --- a/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/refactoring/ResourceRelocationContext.xtend +++ b/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/refactoring/ResourceRelocationContext.xtend @@ -48,7 +48,7 @@ class ResourceRelocationContext { /** * Loads and watches the respective resource and applies the relocation change. - * Clients may usually rather call {@link #addModification()} to register their + * Clients may usually rather call {@link #addModification} to register their * side-effects. * * @param change the change to execute diff --git a/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/serializer/IChangeSerializer.java b/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/serializer/IChangeSerializer.java index 372349238..f42f9e4c8 100644 --- a/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/serializer/IChangeSerializer.java +++ b/org.eclipse.xtext.ide/src/org/eclipse/xtext/ide/serializer/IChangeSerializer.java @@ -25,7 +25,7 @@ import com.google.inject.ImplementedBy; * Converts changes from EMF models to the smallest possible text changes. * * The ChangeSerializer records changes in modifications that are added using - * {@link #addModification(T,IModification)}. All corresponding {@link ITextDocumentChange}s can be retrieved in the + * {@link #addModification(Notifier, IModification) addModification(T, IModification<T>)}. All corresponding {@link ITextDocumentChange}s can be retrieved in the * end by calling {@link #applyModifications(IAcceptor)}. They contain {@link ITextReplacement} which may then be * applied to an editor's contents or to a persisted file. * diff --git a/org.eclipse.xtext.ide/xtend-gen/org/eclipse/xtext/ide/refactoring/IResourceRelocationStrategy.java b/org.eclipse.xtext.ide/xtend-gen/org/eclipse/xtext/ide/refactoring/IResourceRelocationStrategy.java index 3e5625c98..7f46772f6 100644 --- a/org.eclipse.xtext.ide/xtend-gen/org/eclipse/xtext/ide/refactoring/IResourceRelocationStrategy.java +++ b/org.eclipse.xtext.ide/xtend-gen/org/eclipse/xtext/ide/refactoring/IResourceRelocationStrategy.java @@ -17,7 +17,7 @@ import org.eclipse.xtext.ide.refactoring.ResourceRelocationContext; * would make sense is Java, where the package name and the name of the first * public top-level class must match the resource's path. * - * Clients usually call {@link ResourceRelocationContext.addModification()} to + * Clients usually call {@link ResourceRelocationContext#addModification} to * register their side effects. This way it is ensured that the resource is * properly loaded and watched for changes. * diff --git a/org.eclipse.xtext.ide/xtend-gen/org/eclipse/xtext/ide/refactoring/ResourceRelocationContext.java b/org.eclipse.xtext.ide/xtend-gen/org/eclipse/xtext/ide/refactoring/ResourceRelocationContext.java index 6410ed3a1..37c9ff69c 100644 --- a/org.eclipse.xtext.ide/xtend-gen/org/eclipse/xtext/ide/refactoring/ResourceRelocationContext.java +++ b/org.eclipse.xtext.ide/xtend-gen/org/eclipse/xtext/ide/refactoring/ResourceRelocationContext.java @@ -58,7 +58,7 @@ public class ResourceRelocationContext { /** * Loads and watches the respective resource and applies the relocation change. - * Clients may usually rather call {@link #addModification()} to register their + * Clients may usually rather call {@link #addModification} to register their * side-effects. * * @param change the change to execute diff --git a/org.eclipse.xtext.xtext.generator/src/org/eclipse/xtext/xtext/generator/XtextGeneratorLanguage.xtend b/org.eclipse.xtext.xtext.generator/src/org/eclipse/xtext/xtext/generator/XtextGeneratorLanguage.xtend index a240988f8..4aeda9935 100644 --- a/org.eclipse.xtext.xtext.generator/src/org/eclipse/xtext/xtext/generator/XtextGeneratorLanguage.xtend +++ b/org.eclipse.xtext.xtext.generator/src/org/eclipse/xtext/xtext/generator/XtextGeneratorLanguage.xtend @@ -159,7 +159,7 @@ class XtextGeneratorLanguage extends CompositeGeneratorFragment2 implements IXte } /** - * @deprecated Use {@link CodeConfig#isPreferXtendStubs(boolean)} instead + * @deprecated Use {@link CodeConfig#isPreferXtendStubs()} instead */ @Deprecated override isGenerateXtendStubs() { diff --git a/org.eclipse.xtext.xtext.generator/xtend-gen/org/eclipse/xtext/xtext/generator/XtextGeneratorLanguage.java b/org.eclipse.xtext.xtext.generator/xtend-gen/org/eclipse/xtext/xtext/generator/XtextGeneratorLanguage.java index 5206d324a..fb51dfae6 100644 --- a/org.eclipse.xtext.xtext.generator/xtend-gen/org/eclipse/xtext/xtext/generator/XtextGeneratorLanguage.java +++ b/org.eclipse.xtext.xtext.generator/xtend-gen/org/eclipse/xtext/xtext/generator/XtextGeneratorLanguage.java @@ -194,7 +194,7 @@ public class XtextGeneratorLanguage extends CompositeGeneratorFragment2 implemen } /** - * @deprecated Use {@link CodeConfig#isPreferXtendStubs(boolean)} instead + * @deprecated Use {@link CodeConfig#isPreferXtendStubs()} instead */ @Deprecated @Override diff --git a/org.eclipse.xtext/src/org/eclipse/xtext/conversion/IValueConverter.java b/org.eclipse.xtext/src/org/eclipse/xtext/conversion/IValueConverter.java index 8084d5133..32cf55c0c 100644 --- a/org.eclipse.xtext/src/org/eclipse/xtext/conversion/IValueConverter.java +++ b/org.eclipse.xtext/src/org/eclipse/xtext/conversion/IValueConverter.java @@ -62,10 +62,12 @@ public interface IValueConverter { * that is converted, may implement this interface. The framework will * set the rule according to the annotation of the method that provides * the value converter. - * - * @throws IllegalArgumentException if the rule doesn't match the expectation of the value converter */ interface RuleSpecific { + + /** + * @throws IllegalArgumentException if the rule doesn't match the expectation of the value converter + */ void setRule(AbstractRule rule) throws IllegalArgumentException; } } diff --git a/org.eclipse.xtext/src/org/eclipse/xtext/resource/IResourceDescription.java b/org.eclipse.xtext/src/org/eclipse/xtext/resource/IResourceDescription.java index 1080f1260..38f12c75b 100644 --- a/org.eclipse.xtext/src/org/eclipse/xtext/resource/IResourceDescription.java +++ b/org.eclipse.xtext/src/org/eclipse/xtext/resource/IResourceDescription.java @@ -163,9 +163,9 @@ public interface IResourceDescription extends ISelectable { /** * Add a listener to the event source. Listeners will not be added twice. Subsequent calls to - * {@link #addListener(Listener)} will not affect the number of events that the listener receives. - * {@link #removeListener(Listener)} will remove the listener immediately independently from the number of - * invocations of {@link #addListener(Listener)} for the given listener. + * {@link #addListener} will not affect the number of events that the listener receives. + * {@link #removeListener} will remove the listener immediately independently from the number of + * invocations of {@link #addListener} for the given listener. * * @param listener * the listener to be registered. May not be null. @@ -173,9 +173,9 @@ public interface IResourceDescription extends ISelectable { void addListener(Listener listener); /** - * Immediately removes a registered listener from the source. However if {@link #removeListener(Listener)} + * Immediately removes a registered listener from the source. However if {@link #removeListener} * is called during a notification, the removed listener will still receive the event. If the listener has - * not been registered before, the {@link #removeListener(Listener)} does nothing. + * not been registered before, the {@link #removeListener} does nothing. * * @param listener * the listener to be removed. May not be null.