Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ public Class<? extends IQualifiedNameProvider> bindIQualifiedNameProvider() {
}

/**
* Returns the Javadoc-like documentation provider binding.
*
* @return a JavaDoc-like documentation provider
*/
public Class<? extends IEObjectDocumentationProvider> bindIEObjectDocumentationProvider() {
Expand All @@ -99,7 +101,11 @@ public void configureIScopeProviderDelegate(final com.google.inject.Binder binde
binder.bind(IScopeProvider.class).annotatedWith(Names.named(org.eclipse.xtext.scoping.impl.AbstractDeclarativeScopeProvider.NAMED_DELEGATE)).to(XImportSectionNamespaceScopeProvider.class);
}

/** @return a strategy for selecting the objects to export in Index */
/**
* Returns the strategy for selecting objects to export in the index.
*
* @return a strategy for selecting the objects to export in Index
*/
@Override
public Class<? extends org.eclipse.xtext.resource.IDefaultResourceDescriptionStrategy> bindIDefaultResourceDescriptionStrategy() {
return CheckResourceDescriptionStrategy.class;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@


/**
* Provides documentation extracted from Javadoc comments.
*
* @author Christoph Kulla - Initial contribution and API
*/
@SuppressWarnings("nls")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ protected String getBundleSymbolicName(final Class<?> classe) {
}

/**
* Returns a label for the grammar.
*
* @return a text representation of the grammar in which the last segment
* appears first (like in content assist.)
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@


/**
* Identifies a composed check validator.
*
* @author Sebastian Zarnekow - Initial contribution and API
*/
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ public void configure(final IHighlightingConfigurationAcceptor acceptor) {
}

/**
* Returns the text style for Javadoc comments.
*
* @return a bluish TextStyle for JavaDoc comments
*/
public TextStyle javaDocCommentTextStyle() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,37 +45,65 @@ public class CheckImages {
@Inject
private IImageHelper imageHelper;

/** @return an image representing a Java package */
/**
* Returns an image representing a Java package.
*
* @return an image representing a Java package
*/
public Image forPackage() {
return getJdtImage(JavaPluginImages.DESC_OBJS_PACKAGE);
}

/** @return an image representing a Check resource */
/**
* Returns an image representing a Check resource.
*
* @return an image representing a Check resource
*/
public Image forResource() {
return imageHelper.getImage(RESOURCE_IMAGE);
}

/** @return an image representing a JDT import container. */
/**
* Returns an image representing a JDT import container.
*
* @return an image representing a JDT import container
*/
public Image forImportContainer() {
return getJdtImage(JavaPluginImages.DESC_OBJS_IMPCONT);
}

/** @return an image representing a Java import statement. */
/**
* Returns an image representing a Java import statement.
*
* @return an image representing a Java import statement
*/
public Image forImport() {
return getJdtImage(JavaPluginImages.DESC_OBJS_IMPDECL);
}

/** @return an image representing a Check catalog. */
/**
* Returns an image representing a Check catalog.
*
* @return an image representing a Check catalog
*/
public Image forCheckCatalog() {
return forResource();
}

/** @return an image representing a category. */
/**
* Returns an image representing a category.
*
* @return an image representing a category
*/
public Image forCategory() {
return imageHelper.getImage(CATEGORY_IMAGE);
}

/** @return an image representing a category. */
/**
* Returns an image representing a severity range.
*
* @return an image representing a severity range
*/
public Image forSeverityRange() {
return imageHelper.getImage(SEVERITY_RANGE_IMAGE);
}
Expand All @@ -100,7 +128,11 @@ public Image forCheck(final SeverityKind severity) {
}
}

/** @return an image representing a Check context. */
/**
* Returns an image representing a Check context.
*
* @return an image representing a Check context
*/
public Image forContext() {
return getJdtImage(JavaElementImageProvider.getTypeImageDescriptor(false, true, Flags.AccPublic, false));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,29 @@ public class CheckCfgImages {
@Inject
private IImageHelper imageHelper;

/** @return an image representing a Check Configuration resource */
/**
* Returns an image representing a Check Configuration resource.
*
* @return an image representing a Check Configuration resource
*/
public Image forResource() {
return imageHelper.getImage(RESOURCE_IMAGE);
}

/** @return an image representing a Check Configuration */
/**
* Returns an image representing a Check Configuration.
*
* @return an image representing a Check Configuration
*/
public Image forCheckConfiguration() {
return forResource();
}

/** @return an image representing a configured category */
/**
* Returns an image representing a configured category.
*
* @return an image representing a configured category
*/
public Image forConfiguredCatalog() {
return imageHelper.getImage(CATEGORY_IMAGE);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@
*/
class FixedDefaultWorkbench {

/** @see org.eclipse.e4.ui.internal.workbench.swt.PartRenderingEngine#getLimboShell() */
/**
* Identifies the limbo shell.
*
* @see org.eclipse.e4.ui.internal.workbench.swt.PartRenderingEngine#getLimboShell()
*/
@SuppressWarnings("restriction")
private static final String LIMBO_SHELL = "PartRenderingEngine's limbo"; //$NON-NLS-1$
private static final String QUIK_ACCESS_SHELL = "Quick Access"; //$NON-NLS-1$
Expand Down Expand Up @@ -182,4 +186,4 @@ private IWorkbenchPage activePage() {

}

/* Copyright (c) Avaloq Group AG */
/* Copyright (c) Avaloq Group AG */
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ public String toString() {
}

/**
* Gated predicate: {condition}?=>
* Validating predicate: {condition message}?
* Gated predicate: {condition}?=>.
* Validating predicate: {condition message}?.
*/
@EmfAdaptable
public static class SemanticPredicate {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,17 @@ public AbstractValidElementBase[] getChildElements() {
}

/**
* Returns the identifier that distinguishes extension instances.
*
* @return the id that tells one extension instance from another
*/
public String getExtensionId() {
return configurationElement.getDeclaringExtension().getSimpleIdentifier();
}

/**
* Returns the name of the XML element that defines this class.
*
* @return the name of the XML element that defines this class
*/
public String getElementTypeName() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,17 @@ private ValidExtension(final IExtension e) {
}

/**
* Returns the identifier that distinguishes extension instances.
*
* @return the id that tells one extension instance from another
*/
public String getExtensionId() {
return extension.getSimpleIdentifier();
}

/**
* Returns the top-level elements of this extension point.
*
* @return the top-level elements of this extension point
*/
public ValidElement[] getTopLevelElements() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@
public interface IExtendedLocator {

/**
* Defines how locators are aggregated.
*
* @see IExtendedLocator#getPrecedence().
*/
enum AggregationPolicy {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
public interface IIssueStore {

/**
* Returns all stored issues.
*
* @return all stored issues.
*/
Multimap<URI, Issue> getIssues();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
public interface IResourceDescription2 extends IResourceDescription {

/**
* Returns the imported names on which the described resource depends.
*
* @return the map of names the described resource depends on and their types.
*/
Map<QualifiedName, Set<EClass>> getImportedNamesTypes();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ enum Instruction {
}

/**
* Returns the load mode to be used to load the given resource:
* Returns the load mode to be used to load the given resource.
* The mode is determined as follows:
* <ol>
* <li>If the resource is not contained in any resource set this method will return {@link #PARSE}.</li>
* <li>If the resource set's load options specify a load mode, that is returned.</li>
Expand Down Expand Up @@ -197,4 +198,4 @@ public String toString() {
Instruction instruction(Constituent constituent);
}

/* Copyright (c) Avaloq Group AG */
/* Copyright (c) Avaloq Group AG */
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,8 @@ public synchronized IEObjectDescription getSingleElement(final EObject object) {
}

/**
* Returns the identifier of this scope.
*
* @return the id
*/
public String getId() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,17 @@ public AliasingEObjectDescription(final QualifiedName name, final IEObjectDescri
}

/**
* Returns the original name by which this element can be accessed.
*
* @return the original name, this element can be accessed by.
*/
public QualifiedName getOriginalName() {
return delegate.getName();
}

/**
* Returns the original qualified name of the element.
*
* @return the original qualified name of the element.
*/
public QualifiedName getOriginalQualifiedName() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ public class DelegatingScope extends AbstractRecursiveScope {
private static String stackOverflowScopeId;

/**
* Identifies the description used when a stack overflow occurs.
*
* @see #STACK_OVERFLOW_SCOPE
*/
private static final IEObjectDescription STACK_OVERFLOW_EOBJECT_DESCRIPTION = new IEObjectDescription() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ private ResourceValidationRuleSummaryEvent.Collector getTraceCollector(final EOb
}

/**
* Returns the preference store for this validator.
*
* @return the preference store (based on Scopes, but without UI) for that validator.
*/
protected ValidPreferenceStore getValidPreferenceStore() {
Expand Down
Loading