Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[author] Extract out legacy usage of author annotations in favor of adding to pom #568

Merged
merged 1 commit into from
May 27, 2023
Merged
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 @@ -31,8 +31,6 @@
* An implementation of {@link PropertiesProvider} that adds {@value #COPYRIGHT_LAST_YEAR_KEY} and
* {@value #COPYRIGHT_YEARS_KEY} values - see {@link #adjustProperties(AbstractLicenseMojo, Map,
* Document)}.
*
* @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
*/
public class CopyrightRangeProvider implements PropertiesProvider {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@
* An implementation of {@link PropertiesProvider} that adds {@value
* #COPYRIGHT_CREATION_AUTHOR_NAME_KEY} and {@value #COPYRIGHT_CREATION_AUTHOR_EMAIL_KEY} values -
* see {@link #adjustProperties(AbstractLicenseMojo, Map, Document)}.
*
* @author masakimu
*/
public class CopyrightAuthorProvider implements PropertiesProvider {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@
* An implementation of {@link PropertiesProvider} that adds {@value #COPYRIGHT_LAST_YEAR_KEY} and
* {@value #COPYRIGHT_YEARS_KEY} values - see {@link #adjustProperties(AbstractLicenseMojo, Map,
* Document)}.
*
* @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
*/
public class CopyrightRangeProvider implements PropertiesProvider {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@

/**
* A jGit library wrapper to query the date of the last commit.
*
* @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
*/
public class GitLookup implements Closeable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@
/**
* A utility to transform native {@link File} paths to the form expected by jGit - i.e. relative to git working tree
* root directory and delimited by {@code '/'}.
*
* @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
*/
public class GitPathResolver {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@
import java.util.HashMap;
import java.util.Map;

/**
* @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
*/
class CopyrightAuthorProviderTest {

private static Path gitRepoRoot;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@
import java.util.HashMap;
import java.util.Map;

/**
* @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
*/
class CopyrightRangeProviderTest {

private static Path gitRepoRoot;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

/**
* @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
*/
class GitLookupTest {

private static Path gitRepoRoot;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

/**
* @author <a href="mailto:ppalaga@redhat.com">Peter Palaga</a>
*/
class GitPathResolverTest {

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@
/**
* An implementation of {@link PropertiesProvider} that uses SVN to retrieve
* year information of last modification of files.
*
* @author Matthieu Brouillard
*/
public class SVNPropertiesProvider implements PropertiesProvider {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@

/**
* Simple wrapper class to transport login/password information.
*
* @author Matthieu Brouillard
*/
public class Credentials {
private final String login;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@
*/
package com.mycila.maven.plugin.license;

/**
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
* 2013-08-01
*/
public final class Default {

private Default() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@
import com.mycila.maven.plugin.license.header.HeaderDefinition;
import org.apache.maven.plugins.annotations.Parameter;

/**
* @author Mathieu Carbou
*/
public class HeaderStyle {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@

/**
* Check if the source files of the project have a valid license header
*
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
*/
@Mojo(name = "check", defaultPhase = LifecyclePhase.VERIFY, threadSafe = true)
public final class LicenseCheckMojo extends AbstractLicenseMojo {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@

/**
* Reformat files with a missing header to add it
*
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
*/
@Mojo(name = "format", threadSafe = true)
public final class LicenseFormatMojo extends AbstractLicenseMojo {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@

/**
* Remove the specified header from source files
*
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
*/
@Mojo(name = "remove", threadSafe = true)
public final class LicenseRemoveMojo extends AbstractLicenseMojo {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import java.util.Properties;

/**
* @author Mathieu Carbou (mathieu.carbou@gmail.com) 2013-08-27
*/
public interface PropertiesProvider extends Closeable {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@

import static java.nio.charset.StandardCharsets.UTF_8;

/**
* @author Mathieu Carbou
*/
public class Report {

enum Action {CHECK, FORMAT, REMOVE}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
* Base class for all policy enforcer implementations.
*
* @param <T>
* @author Royce Remer
*/
public abstract class AbstractLicensePolicyEnforcer<T> implements LicensePolicyEnforcer<T> {
private final LicensePolicy policy;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@
* 1) defaultPolicy: unless overridden via setDefaultPolicy, this will DENY all artifacts.
* 2) APPROVE policies: any policy in the Set which have {@link LicensePolicy.Rule.APPROVE}
* 3) DENY policies: any policy in the Set which have {@link LIcensePolicy.Rule.DENY}
*
* @author Royce Remer
*/
@SuppressWarnings("rawtypes")
public class AggregateLicensePolicyEnforcer {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@

/**
* Make policy decisions on a {@link Artifact} based on an {@link ArtifactFilter}.
*
* @author Royce Remer
*/
public class ArtifactLicensePolicyEnforcer extends AbstractLicensePolicyEnforcer<Artifact> {
private ArtifactFilter filter;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@

/**
* A default deny ArtifactLicensePolicyEnforcer.
*
* @author Royce Remer
*/
public class DefaultLicensePolicyEnforcer extends ArtifactLicensePolicyEnforcer {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@
/**
* To be implemented by different project/build-framework scanners presenting
* licenses of dependencies.
*
* @author Royce Remer
*/
public interface LicenseMap {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@

/**
* Expose message text to config and tests.
*
* @author Royce Remer
*/
public interface LicenseMessage {
String WARN_POLICY_DENIED = "Some licenses were denied by policy:";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@

/**
* Make policy decisions on a {@link License} based on the license name.
*
* @author Royce Remer
*/
public class LicenseNameLicensePolicyEnforcer extends AbstractLicensePolicyEnforcer<License> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
/**
* A policy decision based on some matcher/value and type. Different policy
* enforcers should take this class as a constructor argument.
*
* @author Royce Remer
*/
public class LicensePolicy {
public enum Type {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@

/**
* Methods exposed by enforcer implementations using {@link LicensePolicy}.
*
* @author Royce Remer
*/
public interface LicensePolicyEnforcer<T> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@

/**
* Make policy decisions on a {@link License} based on the license URL.
*
* @author Royce Remer
*/
public class LicenseURLLicensePolicyEnforcer extends AbstractLicensePolicyEnforcer<License> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@
/**
* Helper class for building Artifact/License mappings from a maven project
* (multi module or single).
*
* @author Royce Remer
*/
public class MavenProjectLicenses implements LicenseMap, LicenseMessage {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,6 @@

import java.util.Map;

/**
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
* 2013-08-27
*/
public interface DocumentPropertiesLoader {

Map<String, String> load(Document d);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@
* user-supplied values. <p> Values for substitution can be supplied using a {@link Properties} instance or
* using a {@link Function}.
*
* @author Juergen Hoeller
* @author Rob Harrop
* @since 3.0
*/
class PropertyPlaceholderResolver {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@
* &lt;/xs:complexType&gt;
* &lt;/xs:schema&gt;
* </pre>
*
* @author Cedric Pronzato
*/
public final class AdditionalHeaderDefinition {
private final Map<String, HeaderDefinition> definitions = new HashMap<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@
/**
* The <code>Header</code> class wraps the license template file, the one which have to be outputted inside the other
* files.
*
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
*/
public final class Header {
private final HeaderSource location;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
* The <code>HeaderDefinition</code> class defines what is needed to output a header text into the of the given file
* type and what is needed to match the first line as well as the last line of a previous header of the given file
* type. Optionally you can define the lines you want to skip before outputting the header.
*
* @author Cedric Pronzato
*/
public final class HeaderDefinition {
private final String type;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
* within a section of the file which match the given <code>HeaderDefinition</code> associated to this
* <code>HeaderParser</code>.
*
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
* @see com.mycila.maven.plugin.license.header.HeaderDefinition
*/
public final class HeaderParser {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@

/**
* Provides an access to the license template text.
*
* @author <a href="https://github.com/ppalaga">Peter Palaga</a>
*/
public abstract class HeaderSource {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
/**
* Defines the default header definitions available out of the box within this plugin.
*
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
* @author Cedric Pronzato
* @see com.mycila.maven.plugin.license.header.HeaderDefinition
*/
public enum HeaderType {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@

import static com.mycila.maven.plugin.license.util.FileUtils.read;

/**
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
*/
public final class FileContent {
private final File file;
private final StringBuilder fileContent;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@
*/
package com.mycila.maven.plugin.license.util;

/**
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
*/
public final class StringUtils {

private StringUtils() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@
import java.net.URL;
import java.net.URLClassLoader;

/**
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
*/
final class CustomClassLoader extends URLClassLoader {
CustomClassLoader() {
super(new URL[0], null);
Expand Down
3 changes: 0 additions & 3 deletions license-maven-plugin/src/test/java/MyPropertiesProvider.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
import java.util.HashMap;
import java.util.Map;

/**
* @author Mathieu Carbou (mathieu.carbou@gmail.com) 2013-08-27
*/
public final class MyPropertiesProvider implements PropertiesProvider {

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@

import java.util.UUID;

/**
* @author Matthieu Brouillard
*/
class AbstractLicenseMojoTest {

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
import java.io.File;
import java.util.Collections;

/**
* @author Mathieu Carbou (mathieu.carbou@gmail.com)
*/
class AdditionalHeaderMojoTest {
@Test
void test_additionalHeaderDefinitions() throws Exception {
Expand Down
Loading