add missing @since tags

This commit is contained in:
Stefan Oehme 2015-10-09 11:57:36 +02:00
parent 0b0566a38a
commit 0ddcec41c9
30 changed files with 64 additions and 3 deletions

View file

@ -12,7 +12,7 @@ Require-Bundle: org.eclipse.xtext;visibility:=reexport,
Import-Package: org.apache.log4j;version="1.2.15"
Export-Package: org.eclipse.xtext.ide;x-friends:="org.eclipse.xtend.ide",
org.eclipse.xtext.ide.editor.bracketmatching;x-friends:="org.eclipse.xtend.ide.common,org.eclipse.xtend.ide",
org.eclipse.xtext.ide.editor.contentassist;x-friends:="org.eclipse.xtend.ide,org.eclipse.xtext.xbase.ide",
org.eclipse.xtext.ide.editor.contentassist,
org.eclipse.xtext.ide.editor.contentassist.antlr,
org.eclipse.xtext.ide.editor.contentassist.antlr.internal,
org.eclipse.xtext.ide.editor.model;x-internal:=true,

View file

@ -23,6 +23,7 @@ import com.google.inject.Provider;
/**
* Abstraction of a commonly used set of attributes related to the current content assist request.
* @since 2.9
*/
public class ContentAssistContext {

View file

@ -14,6 +14,9 @@ import org.eclipse.xtend.lib.annotations.ToString
import org.eclipse.xtext.util.ReplaceRegion
import org.eclipse.xtext.util.TextRegion
/**
* @noreference
*/
@Accessors
@ToString(skipNulls = true)
@EqualsHashCode

View file

@ -8,7 +8,9 @@
package org.eclipse.xtext.ide.editor.contentassist;
import org.eclipse.xtext.AbstractElement;
/**
* @since 2.9
*/
public interface IFollowElementAcceptor {
void accept(AbstractElement element);

View file

@ -9,6 +9,9 @@ package org.eclipse.xtext.ide.editor.contentassist
import org.eclipse.xtext.ide.editor.contentassist.ContentAssistEntry
/**
* @noreference
*/
interface IIdeContentProposalAcceptor {
def void accept(ContentAssistEntry entry, int priority)

View file

@ -15,6 +15,7 @@ import org.eclipse.xtext.resource.IEObjectDescription
/**
* Determines priorities for content assist proposal entries. The priorities can be used
* to sort the list of proposals.
* @noreference
*/
@Singleton
@Accessors(PROTECTED_GETTER, PROTECTED_SETTER)

View file

@ -30,6 +30,7 @@ import org.eclipse.xtext.xtext.CurrentTypeFinder
* Generic content proposal provider for use in different IDE contexts. This provider is
* <em>not</em> used by the Eclipse integration, which has its own abstraction for
* content assist proposals.
* @noreference
*/
class IdeContentProposalProvider {

View file

@ -21,6 +21,7 @@ import org.eclipse.xtext.scoping.IScope
/**
* Special content assist proposal provider for cross-references.
* @noreference
*/
class IdeCrossrefProposalProvider {

View file

@ -38,6 +38,9 @@ import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.name.Named;
/**
* @since 2.9
*/
public abstract class AbstractContentAssistParser implements IContentAssistParser {
@Inject

View file

@ -36,6 +36,7 @@ import com.google.inject.Inject;
/**
* Base class for content assist parsers that can reduce the input preceding the cursor
* position without any impact on the follow set.
* @since 2.9
*/
public abstract class AbstractPartialContentAssistParser extends AbstractContentAssistParser implements IPartialContentAssistParser {

View file

@ -30,6 +30,9 @@ import org.eclipse.xtext.util.XtextSwitch;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
/**
* @since 2.9
*/
public class CallHierarchyHelper extends XtextSwitch<Boolean> {
private final EObject nextGrammarElement;
private Set<AbstractRule> visiting = new HashSet<AbstractRule>();

View file

@ -55,6 +55,9 @@ import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.name.Named;
/**
* @since 2.9
*/
public class ContentAssistContextFactory implements Function<ContentAssistContext.Builder, ContentAssistContext> {
private static final Logger log = Logger.getLogger(ContentAssistContextFactory.class);

View file

@ -21,6 +21,7 @@ import org.eclipse.xtext.parser.IParseResult;
/**
* Used by the {@link AbstractPartialContentAssistParser} to find the node at which to start parsing.
* @since 2.9
*/
public class EntryPointFinder {
public ICompositeNode findEntryPoint(IParseResult parseResult, int offset) {

View file

@ -14,6 +14,7 @@ import org.eclipse.xtext.AbstractElement;
/**
* Simple bean that reflects the current state, when the content assist parser
* hit EOF.
* @since 2.9
*/
public class FollowElement {

View file

@ -34,6 +34,9 @@ import org.eclipse.xtext.xtext.ParameterConfigHelper;
import com.google.common.collect.Sets;
/**
* @since 2.9
*/
public class FollowElementCalculator extends XtextSwitch<Boolean> {
protected IFollowElementAcceptor acceptor;

View file

@ -34,7 +34,7 @@ import com.google.common.collect.Multimap;
import com.google.inject.Inject;
/**
*
* @since 2.9
*/
public class FollowElementComputer {

View file

@ -11,6 +11,7 @@ import java.util.Collection;
/**
* Parser that returns the expected elements when EOF is reached.
* @since 2.9
*/
public interface IContentAssistParser {

View file

@ -13,6 +13,7 @@ import org.eclipse.xtext.parser.IParseResult;
/**
* A content assist parser that can skip parts of the document for faster parsing
* @since 2.9
*/
public interface IPartialContentAssistParser extends IContentAssistParser {

View file

@ -11,6 +11,9 @@ import org.eclipse.xtext.nodemodel.ICompositeNode;
import org.eclipse.xtext.nodemodel.ILeafNode;
import org.eclipse.xtext.nodemodel.INode;
/**
* @since 2.9
*/
public class LeafNodeFinder {
private final int offset;
private final boolean leading;

View file

@ -10,6 +10,9 @@ package org.eclipse.xtext.ide.editor.contentassist.antlr;
import org.antlr.runtime.Token;
import org.eclipse.xtext.AbstractElement;
/**
* @since 2.9
*/
public abstract class LookAheadTerminal {
private Token token;

View file

@ -11,6 +11,9 @@ import org.eclipse.xtext.AbstractElement;
import org.eclipse.xtext.RuleCall;
import org.eclipse.xtext.TerminalRule;
/**
* @since 2.9
*/
public class LookAheadTerminalRuleCall extends LookAheadTerminal {
private TerminalRule rule;

View file

@ -10,6 +10,9 @@ package org.eclipse.xtext.ide.editor.contentassist.antlr;
import org.eclipse.xtext.AbstractElement;
import org.eclipse.xtext.Keyword;
/**
* @since 2.9
*/
public class LookaheadKeyword extends LookAheadTerminal {
private String keyword;

View file

@ -12,6 +12,9 @@ import org.antlr.runtime.TokenSource;
import org.eclipse.xtext.parser.antlr.ITokenDefProvider;
import org.eclipse.xtext.parser.antlr.XtextTokenStream;
/**
* @since 2.9
*/
public class ObservableXtextTokenStream extends XtextTokenStream {
public interface StreamListener {

View file

@ -16,6 +16,9 @@ import org.eclipse.xtext.nodemodel.ILeafNode;
import org.eclipse.xtext.nodemodel.INode;
import org.eclipse.xtext.util.Strings;
/**
* @since 2.9
*/
public class PartialContentAssistContextFactory extends ContentAssistContextFactory {
@Override
protected void createContextsForLastCompleteNode(EObject previousModel, boolean strict) {

View file

@ -25,6 +25,7 @@ import com.google.inject.Singleton;
/**
* @author Sebastian Zarnekow - Initial contribution and API
* @since 2.9
*/
@Singleton
public class RequiredRuleNameComputer {

View file

@ -45,6 +45,9 @@ import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
/**
* @since 2.9
*/
public abstract class AbstractInternalContentAssistParser extends Parser implements
ObservableXtextTokenStream.StreamListener, ITokenDefProvider {

View file

@ -14,6 +14,9 @@ import org.antlr.runtime.Token;
import org.eclipse.xtext.parser.antlr.IUnorderedGroupHelper;
import org.eclipse.xtext.parser.antlr.XtextTokenStream;
/**
* @since 2.9
*/
public class DFA extends org.antlr.runtime.DFA {
@Override

View file

@ -7,5 +7,8 @@
*******************************************************************************/
package org.eclipse.xtext.ide.editor.contentassist.antlr.internal;
/**
* @since 2.9
*/
@SuppressWarnings("serial")
public class InfiniteRecursion extends RuntimeException {}

View file

@ -11,6 +11,9 @@ import org.antlr.runtime.CharStream;
import org.antlr.runtime.RecognizerSharedState;
import org.apache.log4j.Logger;
/**
* @since 2.9
*/
public abstract class Lexer extends org.antlr.runtime.Lexer {
private static final Logger logger = Logger.getLogger(Lexer.class);

View file

@ -16,6 +16,7 @@ import java.util.LinkedHashSet;
* with caution.
*
* @author Sebastian Zarnekow - Initial contribution and API
* @since 2.9
*/
public class LinkedHashSetWithoutNull<T> extends LinkedHashSet<T> {
private static final long serialVersionUID = 1L;