Skip to content

Commit

Permalink
Merge pull request dsldevkit#837 from joaodinissf/mrqa
Browse files Browse the repository at this point in the history
Remove empty inheritDoc's + format all files
  • Loading branch information
joaodinissf authored Nov 13, 2023
2 parents e0253c4 + c7dcb17 commit a355534
Show file tree
Hide file tree
Showing 413 changed files with 258 additions and 807 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import java.util.Set;

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.LogManager;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IWorkspaceRoot;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,6 @@ public final class CheckConstants {
public static final String IT = "it"; //$NON-NLS-1$
public static final QualifiedName QNIT = QualifiedName.create(IT);

private CheckConstants() {}
private CheckConstants() {
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ public static void doSetup() {
new CheckStandaloneSetup().createInjectorAndDoEMFRegistration();
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,3 @@ public String getName() {
}
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
*/
public class DocumentedImplCustom extends DocumentedImpl {

/** {@inheritDoc} */
@Override
public String getDescription() {
if (!this.eIsProxy() && this.eResource() != null) {
Expand All @@ -36,4 +35,3 @@ public String getDescription() {
return null;
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,6 @@ protected void internalToConvertedExpression(final XExpression obj, final ITreeA
}
}

/** {@inheritDoc} */
// CHECKSTYLE:OFF
protected void _toJavaStatement(final XGuardExpression expr, final ITreeAppendable b, final boolean isReferenced) {
// CHECKSTYLE:ON
Expand Down Expand Up @@ -225,14 +224,12 @@ protected void appendImmutableCollectionExpression(final XCollectionLiteral lite
super.appendImmutableCollectionExpression(literal, b, collectionsMethod, guavaHelper, guavaHelperMethod);
}

/** {@inheritDoc} */
// CHECKSTYLE:OFF
protected void _toJavaExpression(final XGuardExpression expr, final ITreeAppendable b) {
// CHECKSTYLE:ON
b.append(getVarName(expr, b));
}

/** {@inheritDoc} */
// CHECKSTYLE:OFF
protected void _toJavaStatement(final XIssueExpression expr, final ITreeAppendable b, final boolean isReferenced) { // NOPMD NPath complexity
// CHECKSTYLE:ON
Expand Down Expand Up @@ -364,7 +361,6 @@ private String getLoggerString(final XIssueExpression expr) {
+ " for \" + " + getContextImplicitVariableName(expr) + ".eResource().getURI() + \" at \" + stackTraceElements[1].toString()";
}

/** {@inheritDoc} */
// CHECKSTYLE:OFF
@SuppressWarnings("restriction")
protected JvmType findEPackageInterfaceType(final ENamedElement element, final EObject context) {
Expand All @@ -374,7 +370,6 @@ protected JvmType findEPackageInterfaceType(final ENamedElement element, final E
return getTypeComputationServices().getTypeReferences().findDeclaredType(qualifiedPackageInterfaceName, context);
}

/** {@inheritDoc} */
// CHECKSTYLE:OFF
protected void _toJavaExpression(final XIssueExpression expr, final ITreeAppendable b) {
// CHECKSTYLE:ON
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@ private CheckGeneratorConstants() {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,3 @@ QualifiedName qualifiedName(final Check check) {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,3 @@ public EStructuralFeature getIdentifierFeature(final EObject object) {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,3 @@ public boolean createEObjectDescriptions(final EObject eObject, final IAcceptor<
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,3 @@ public List<EObject> getLinkedObjects(final EObject context, final EReference re
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@
* Contributors:
* Avaloq Group AG - initial API and implementation
*******************************************************************************/
package com.avaloq.tools.ddk.check.serializer;
package com.avaloq.tools.ddk.check.serializer;

/**
* Semantic sequencer for Check DSL.
*/
public class CheckSemanticSequencer extends AbstractCheckSemanticSequencer {
public class CheckSemanticSequencer extends AbstractCheckSemanticSequencer {

}
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
* Contributors:
* Avaloq Group AG - initial API and implementation
*******************************************************************************/
package com.avaloq.tools.ddk.check.serializer;
package com.avaloq.tools.ddk.check.serializer;

/**
* Syntactic sequencer for Check DSL.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,3 @@ public boolean hasSideEffects(final XExpression expr) {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,3 @@ public String getBundleSymbolicName() {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,3 @@ public List<String> getMetamodelPackages() {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ public void checkFileNamingConventions(final CheckCatalog catalog) {
}
String catalogName = catalog.getName();
if (catalogName != null && !equal(resourceURI.trimFileExtension().lastSegment(), catalogName)) {
error("The catalog '" + (packageName != null ? notNull(packageName) + DOT : "") + catalogName + "' must be defined in its own file", catalog, CheckPackage.Literals.CHECK_CATALOG__NAME, ValidationMessageAcceptor.INSIGNIFICANT_INDEX, IssueCodes.WRONG_FILE);
error("The catalog '" + (packageName != null ? notNull(packageName) + DOT : "") + catalogName
+ "' must be defined in its own file", catalog, CheckPackage.Literals.CHECK_CATALOG__NAME, ValidationMessageAcceptor.INSIGNIFICANT_INDEX, IssueCodes.WRONG_FILE);
}
}

Expand All @@ -90,9 +91,11 @@ public void checkFileNamingConventions(final CheckCatalog catalog) {
*/
protected void reportInvalidPackage(final CheckCatalog catalog, final String givenPackageName, final String expectedPackageName) {
if (expectedPackageName != null) {
error("The declared package '" + notNull(givenPackageName) + "' does not match the expected package", catalog, CheckPackage.Literals.CHECK_CATALOG__PACKAGE_NAME, ValidationMessageAcceptor.INSIGNIFICANT_INDEX, IssueCodes.WRONG_PACKAGE, expectedPackageName);
error("The declared package '" + notNull(givenPackageName)
+ "' does not match the expected package", catalog, CheckPackage.Literals.CHECK_CATALOG__PACKAGE_NAME, ValidationMessageAcceptor.INSIGNIFICANT_INDEX, IssueCodes.WRONG_PACKAGE, expectedPackageName);
} else {
error("The declared package '" + notNull(givenPackageName) + "' does not match the expected package", catalog, CheckPackage.Literals.CHECK_CATALOG__PACKAGE_NAME, ValidationMessageAcceptor.INSIGNIFICANT_INDEX, IssueCodes.WRONG_PACKAGE);
error("The declared package '" + notNull(givenPackageName)
+ "' does not match the expected package", catalog, CheckPackage.Literals.CHECK_CATALOG__PACKAGE_NAME, ValidationMessageAcceptor.INSIGNIFICANT_INDEX, IssueCodes.WRONG_PACKAGE);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,3 @@ protected void checkRightHandSideHasOnlyIntegralNumbers(final XExpression value,
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ public void checkFormalParameterNumbersAreIntegers(final FormalParameter paramet
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,3 @@ public Function<T, QualifiedName> getNameFunction() {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
*/
package com.avaloq.tools.ddk.check.ide;


/**
* Use this class to register ide components.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ protected Index() {
// Prevent explicit instantiations. To be used via injection.
}

/** {@inheritDoc} */
@Override
public IIndex.Query newQuery(final EClass type, final String namePattern) {
if (type == null || namePattern == null || namePattern.length() == 0) {
Expand All @@ -54,7 +53,6 @@ public IIndex.Query newQuery(final EClass type, final String namePattern) {
return new Query(domainMapper, nameConverter, type).withName(namePattern);
}

/** {@inheritDoc} */
@Override
public IIndex.Query newQuery(final EClass type, final QualifiedName namePattern) {
if (type == null || namePattern == null || namePattern.isEmpty()) {
Expand Down Expand Up @@ -114,7 +112,6 @@ private Query withName(final QualifiedName namePattern) {
return this;
}

/** {@inheritDoc} */
@Override
public Query withData(final String key, final String value) {
if (key == null || value == null) {
Expand All @@ -124,7 +121,6 @@ public Query withData(final String key, final String value) {
return this;
}

/** {@inheritDoc} */
@Override
public Iterable<IIndex.Entry> run(final EObject context) {
if (context == null) {
Expand Down Expand Up @@ -165,25 +161,21 @@ protected Entry(final EObject context, final IQualifiedNameConverter nameConvert
this.delegate = internalDescription;
}

/** {@inheritDoc} */
@Override
public String getName() {
return nameConverter.toString(getQualifiedName());
}

/** {@inheritDoc} */
@Override
public QualifiedName getQualifiedName() {
return delegate.getQualifiedName();
}

/** {@inheritDoc} */
@Override
public EClass getType() {
return delegate.getEClass();
}

/** {@inheritDoc} */
@Override
public EObject getModelObject() {
EObject result = delegate.getEObjectOrProxy();
Expand All @@ -193,7 +185,6 @@ public EObject getModelObject() {
return result;
}

/** {@inheritDoc} */
@Override
public String[] getDataKeys() {
String[] result = delegate.getUserDataKeys();
Expand All @@ -203,7 +194,6 @@ public String[] getDataKeys() {
return result;
}

/** {@inheritDoc} */
@Override
public String getData(final String key) {
if (key == null) {
Expand All @@ -212,7 +202,6 @@ public String getData(final String key) {
return delegate.getUserData(key);
}

/** {@inheritDoc} */
@Override
public String getSourceName() {
final URI uri = delegate.getEObjectURI().trimFragment();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ public class Messages extends NLS {
NLS.initializeMessages(BUNDLE_NAME, Messages.class);
}

private Messages() {}
private Messages() {
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,3 @@ public void testIssuesEnabledDisabled() {

}
}

Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,3 @@ public boolean enabledForCodes(final EObject context) {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,3 @@ public void testAtLeastOneValidatorFound() {
assertEquals("Dummy validator found", "DummyValidator", dummyValidator.getClass().getSimpleName());
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,6 @@ public final class CheckRuntimeConstants {
/** Suffix used in issue codes class names. */
public static final String ISSUE_CODES_CLASS_NAME_SUFFIX = "IssueCodes"; //$NON-NLS-1$

private CheckRuntimeConstants() {}
private CheckRuntimeConstants() {
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import java.net.URL;

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.LogManager;
import org.eclipse.osgi.util.NLS;


Expand All @@ -37,7 +37,6 @@ public AbstractModelLocation(final URL catalogUrl) {
this.catalogUrl = catalogUrl;
}

/** {@inheritDoc} */
@Override
public InputStream getCatalogStream() {
InputStream stream = null;
Expand All @@ -49,19 +48,16 @@ public InputStream getCatalogStream() {
return stream;
}

/** {@inheritDoc} */
@Override
public String getCatalogPath() {
return catalogUrl.getPath();
}

/** {@inheritDoc} */
@Override
public URL getCatalogUrl() {
return catalogUrl;
}

/** {@inheritDoc} */
@Override
public URI getCatalogUri() {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ public interface ICheckConfigurationStoreService {
ICheckConfigurationStore getCheckConfigurationStore(Object context);

}

Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,3 @@ public String getCatalogPath() {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import java.util.Set;

import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.LogManager;
import org.eclipse.emf.ecore.EObject;

import com.google.common.collect.HashMultimap;
Expand All @@ -42,7 +42,6 @@ public class AbstractCheckContext implements ICheckContext {
/** Maps issue codes to the predicate methods that contain that issue code in their annotation. */
private Multimap<String, Method> predicatesForIssueCode;

/** {@inheritDoc} */
@Override
public boolean isCheckValid(final EObject context, final String issueCode) {
if (predicatesForIssueCode == null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,3 @@
String[] issueCodes();

}

Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ public boolean isCheckValid(final EObject context, final String issueCode) {
}

}

Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,3 @@ public boolean isCheckValid(final EObject context, final String issueCode) {

}
}

Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ abstract class AbstractCheckRegistryReader extends RegistryReader {
*/
protected abstract Logger getLogger();

/** {@inheritDoc} */
@Override
protected void logError(final IConfigurationElement element, final String text) {
IExtension extension = element.getDeclaringExtension();
Expand Down Expand Up @@ -104,7 +103,6 @@ protected String getKeyAttribute() {
*/
abstract String getAttribute();

/** {@inheritDoc} */
@Override
protected boolean readElement(final IConfigurationElement element, final boolean add) {
if (element.getName().equals(topLevelElementName())) {
Expand Down
Loading

0 comments on commit a355534

Please sign in to comment.