Skip to content

Commit

Permalink
Fix javadoc references, links and spaces. (liquibase#3768)
Browse files Browse the repository at this point in the history
* Fix javadoc references, links and spaces.

* Minor javadoc tweaks made.

---------
Co-authored-by: Daniel Mallorga <[email protected]>
Co-authored-by: filipe <[email protected]>
  • Loading branch information
arturobernalg authored May 17, 2023
1 parent df7585b commit c6be89d
Show file tree
Hide file tree
Showing 43 changed files with 54 additions and 50 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* Observes CDI container startup events and triggers the Liquibase update
* process via @PostConstruct on CDILiquibase
*
* @author Aaron Walker (http://github.com/aaronwalker)
* @author <a href="http://github.com/aaronwalker">Aaron Walker</a>
*/
public class CDIBootstrap implements Extension {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
*
* }
* </p>
* @author Aaron Walker (http://github.com/aaronwalker)
* @author <a href="http://github.com/aaronwalker">Aaron Walker</a>
*/
@ApplicationScoped
public class CDILiquibase implements Extension {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
/**
* Holds the configuration for Liquibase
*
* @author Aaron Walker (http://github.com/aaronwalker)
* @author <a href="http://github.com/aaronwalker">Aaron Walker </a>
*/
public class CDILiquibaseConfig {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
import java.util.concurrent.Callable;

/**
* @author Nikita Lipatov (https://github.com/islonik)
* @author <a href="https://github.com/islonik)">Nikita Lipatov</a>
*
* @since 27/5/17.
*/
@Singleton
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import java.util.List;

/**
* @author Nikita Lipatov (https://github.com/islonik), antoermo (https://github.com/dikeert)
* @author <a href="https://github.com/islonik">Nikita Lipatov</a>, <a href="https://github.com/dikeert">antoermo</a>
* @since 27/5/17.
*/
@ApplicationScoped
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import java.lang.annotation.Target;

/**
* @author antoermo (https://github.com/dikeert)
* @author <a href="https://github.com/dikeert">antoermo</a>
* @since 31/07/2015
*/
@Qualifier
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import java.lang.annotation.Target;

/**
* @author antoermo (https://github.com/dikeert)
* @author <a href="https://github.com/dikeert">antoermo</a>
* @since 31/07/2015
*/
@Retention(RetentionPolicy.RUNTIME)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
/**
* Qualifier Annotation
*
* @author Aaron Walker (http://github.com/aaronwalker)
* @author <a href="http://github.com/aaronwalker">Aaron Walker </a>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({FIELD,METHOD,PARAMETER,TYPE})
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package liquibase.integration.cdi.exceptions;

/**
* @author antoermo (https://github.com/dikeert)
* @author <a href="https://github.com/dikeert">antoermo</a>
* @since 31/07/2015
*/
public class CyclicDependencyException extends RuntimeException {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package liquibase.integration.cdi.exceptions;

/**
* @author antoermo (https://github.com/dikeert)
* @author <a href="https://github.com/dikeert">antoermo</a>
* @since 31/07/2015
*/
public class DependencyNotFoundException extends RuntimeException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
/**
* A Test CDI Producer used for testing CDILiquibase
*
* @author Aaron Walker (http://github.com/aaronwalker)
* @author <a href="http://github.com/aaronwalker">Aaron Walker</a>
*/
public class CDITestProducer {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@


/**
* @author Nikita Lipatov (https://github.com/islonik),
* @author <a href="https://github.com/islonik)">Nikita Lipatov</a>
* @since 27/5/17.
*/
public class SchemesCDIConfigBuilderTest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import static org.junit.Assert.*;

/**
* @author Nikita Lipatov (https://github.com/islonik), antoermo (https://github.com/dikeert)
* @author <a href="https://github.com/islonik)">Nikita Lipatov</a>, <a href="https://github.com/dikeert">antoermo</a>
* @since 27/5/17.
*/
public class SchemesTreeBuilderTest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ public abstract class AbstractLiquibaseMojo extends AbstractMojo {
* Deprecated and ignored configuration property. Logging is managed via the standard maven logging system
* either using the -e, -X or -q flags or the ${maven.home}/conf/logging/simplelogger.properties file.
*
* See https://maven.apache.org/maven-logging.html for more information.
* @see <a href="https://maven.apache.org/maven-logging.html">maven-logging for more information.</a>
*
* @parameter property="liquibase.logging"
* @deprecated Logging managed by maven
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ public class LiquibaseDatabaseDiff extends AbstractLiquibaseChangeLogMojo {

/**
* Write the output of the diff to a file
*
* <p>
*
* @parameter property="liquibase.outputFile"
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

/**
* This interface defines how objects can be extended with additional attributes at runtime without subclassing and exposes the ability to query attributes without resorting to reflection.
*
* <p>
* If creating an ExtensibleObject, it is usually best to extend {@link liquibase.AbstractExtensibleObject} rather than this interface directly.
* You should also create a test that extends from AbstractExtensibleObjectTest.
*/
Expand Down Expand Up @@ -47,7 +47,7 @@ public interface ExtensibleObject extends Cloneable {
/**
* Works like {@link #get(String, Class)} but if the attribute is null or not defined, returns the passed defaultValue.
* Uses the type of defaultValue to determine the type to convert the current value to.
*
* <p>
* If null is passed to the default value, no conversion of attribute is made if it is set.
* If traversing a dot-separated attribute path, return the default value if any along the path are null.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

/**
* A common parent for all raw SQL related changes regardless of where the sql was sourced from.
*
* <p>
* Implements the necessary logic to choose how the SQL string should be parsed to generate the statements.
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

/**
* Interface all changes (refactorings) implement.
*
* <p>
* Instances of these objects are normally created via the {@link ChangeFactory } by {@link liquibase.parser.ChangeLogParser} implementations.
*
* @see ChangeFactory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* Interface to implement when creating a custom change. Actual custom changes implementations need to
* implement CustomSqlChange or CustomTaskChange.
* <br><br>
* See https://docs.liquibase.com/change-types/custom-change.html for more information.
* @see <a href="https://docs.liquibase.com/change-types/custom-change.html">custom-change for more information.</a>
*/
public interface CustomChange {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public ChangeLogParameters() {
/**
* Creates a new ChangeLogParameters instance, populated with a set of "database.*" global parameters based on the passed database configuration.
* If the database is null, no global parameters are added.
*
* <p>
* The passed database is used as a default value for {@link #getDatabase()}
*/
public ChangeLogParameters(Database database) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

/**
* Contains the result of a {@link liquibase.changelog.filter.ChangeSetFilter#accepts(liquibase.changelog.ChangeSet)} call.
*
* <p>
* {@link #getMessage()}, but {@link #getFilter()} can be used to programmatically determine the reason for accepting or not.
*/
public class ChangeSetFilterResult {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public void willRollback(ChangeSet changeSet, DatabaseChangeLog databaseChangeLo
* @param changeSet changeSet that was rolled back
* @param databaseChangeLog parent change log
* @param database the database the rollback was executed on.
* @param exception the original exception which was thrown
* @param e the original exception which was thrown
*
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public void willRollback(ChangeSet changeSet, DatabaseChangeLog databaseChangeLo
* @param changeSet changeSet that was rolled back
* @param databaseChangeLog parent change log
* @param database the database the rollback was executed on.
* @param exception the original exception which was thrown
* @param e the original exception which was thrown
*
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ protected void preRunCheck(CommandResultsBuilder resultsBuilder) {

/**
* Called by {@link #run(CommandResultsBuilder)} to create the actual arguments passed to {@link Main#run(String[])}.
*
* <p>
* Implementations should generally call {@link #collectArguments(CommandScope, List, String)}
* and possibly {@link #removeArgumentValues(String[], String...)}
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ public <T> T getArgumentValue(CommandArgumentDefinition<T> argument) {
* Assign a value to a given provided dependency. So if a CommandStep provides class X, at
* {@link CommandStep#run(CommandResultsBuilder)} method it needs to provide the value for X using this method.
* commandScope.provideDependency(LockService.class, lockService);
*
* <p>
* Means that this class will LockService.class using object lock
*/
public CommandScope provideDependency(Class<?> clazz, Object value) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

/**
* Firebird database implementation.
* SQL Syntax ref: http://www.ibphoenix.com/main.nfs?a=ibphoenix&page=ibp_60_sqlref
* SQL Syntax ref: <a href="http://www.ibphoenix.com/main.nfs?a=ibphoenix&page=ibp_60_sqlref">ibphoenix</a>
*/
public class FirebirdDatabase extends AbstractJdbcDatabase {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ protected String getQuotingEndCharacter() {

/**
* <p>Returns the default timestamp fractional digits if nothing is specified.</p>
* https://dev.mysql.com/doc/refman/5.7/en/fractional-seconds.html :
* <a href="https://dev.mysql.com/doc/refman/5.7/en/fractional-seconds.html">fractional seconds</a>:
* "The fsp value, if given, must be in the range 0 to 6. A value of 0 signifies that there is no fractional part.
* If omitted, the default precision is 0. (This differs from the STANDARD SQL default of 6, for compatibility
* with previous MySQL versions.)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ public class PostgresDatabase extends AbstractJdbcDatabase {

/**
* Maximum length of PostgresSQL identifier.
* For details see https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS.
* For details:
* @see <a href="https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS">SQL-SYNTAX-IDENTIFIERS</a>.
*/
static final int PGSQL_PK_BYTES_LIMIT = 63;
static final String PGSQL_PK_SUFFIX = "_pkey";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
* This class is used by other classes to filter the set of database objects used
* in diff-type operations including the diff command and the generateChangeLog
* command.
*
* <p>
* There are two basic types of filter - FilterType.INCLUDE and FilterType.EXCLUDE.
* In Each filter type, a filter string can be supplied. That string is a
* comma-separated list of subfilters. Each subfilter can either be a regular expression,
Expand Down Expand Up @@ -110,17 +110,17 @@ public enum FilterType {
/**
* The Filter class is used internally to do the actual work. A Filter consists of
* an objectType and a regex Pattern.
*
* <p>
* The main method is matches(), which returns true if the given DatabaseObject
* matches the filter, and false if it does not match the Filter.
*
* <p>
* If the objectType is null, then just the Pattern is used to compare the "name" of
* the object whether it matches or not.
*
* <p>
* If the objectType is not null, then the objectType of the Filter must be
* assignableFrom the given DatabaseObject, AND the "name" of the DatabaseObject
* must match the Pattern.
*
* <p>
* The "name" of the object might be what is returned from getName(), or it might
* be a different 'identifier' for different objet types.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
/**
* If there is an error with setting up a Change this Exception
* will be thrown.
*
* <p>
* A message must always be provided, if none is then the message
* from the cause exception will be used.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
/**
* Adapter implementation of the ResultSetExtractor interface that delegates
* to a RowMapper which is supposed to create a not null constraint object for each row.
*
* <p>
* Special mapper needed because sys table ALL_CONSTRAINTS provides info about not null constraints
* that have type 'C' and SEARCH_CONDITION(Text of search condition for a check constraint) field with 'is not null' string
* of data type: 'LONG' But type 'LONG' limits us to do any text operations (match, contains, etc.) on DB level
Expand Down
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

/**
* Stores information about the integration running Liquibase.
*
* <p>
* NOTE: This class is under development and will likely change over time.
*/
public class IntegrationDetails {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* To support both javax.servlet and jakarta.servlet implementations, this class wraps the classes we use so that the shared code does not have to depend
* on a particular implementation.
*
* <p>
* NOTE: Only methods which Liquibase currently uses are exposed, which may cause breaking changes if/when new abstract methods are added to the wrappers.
*/
class GenericServletWrapper {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

/**
* This service is used to create named {@link Logger} instances through a {@link LogService}.
*
* <p>
* The default LoggerFactory used in {@link JavaLogService} uses {@link java.util.logging.Logger}
*/
public interface LogService extends Plugin {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ protected AbstractPluginFactory() {
* Finds the plugin for which {@link #getPriority(Plugin, Object...)} returns the highest value for the given scope and args.
* This method is called by a public implementation-specific methods.
* Normally this does not need to be overridden, instead override {@link #getPriority(Plugin, Object...)} to compute the priority of each object for the scope and arguments passed to this method.
*
* <p>
* However, if there is a {@link Scope} key of "liquibase.plugin.${plugin.interface.class.Name}", an instance of that class will always be ran first.
*
* @return null if no plugins are found or have a priority greater than zero.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
/**
* Abstraction for finding and creating instances of classes.
* {@link StandardServiceLocator} is the main implementation, but can be overridden if need be.
*
* <p>
* The ServiceLocator to use should be accessed via {@link Scope#getServiceLocator()}
*/
public interface ServiceLocator extends Plugin {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -431,9 +431,9 @@ protected List<CachedRow> listConstraints(Table table, DatabaseSnapshot snapshot
* Should the given database include the table name in the key?
* Databases that need to include the table names are ones where unique constraint names do not have to be unique
* within the schema.
*
* <p>
* Currently only mysql is known to have non-unique constraint names.
*
* <p>
* If this returns true, the database-specific query in {@link #listColumns(UniqueConstraint, Database, DatabaseSnapshot)} must include
* a TABLE_NAME column in the results for {@link #getCacheKey(Map, Database)} to use.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@
* - and - conjunction operator
* - or - disjunction operator
* - () - increase evaluation order priority for sub-expression
*
* <p>
* Examples:
* "(a and b) or (c and d)"
* "!a and b"
*
* <p>
* Usage:
* @see liquibase.LabelExpression
* @see liquibase.ContextExpression
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ public static String getDirectory(String filename) {

/**
* Remove problematic characters from filename and replace them with '_'
* https://stackoverflow.com/questions/1976007/what-characters-are-forbidden-in-windows-and-linux-directory-names
* @see <a href="https://stackoverflow.com/questions/1976007/what-characters-are-forbidden-in-windows-and-linux-directory-names">
* What characters are forbidden in Windows and Linux directory names?</a>
* <p>
* ' ' '/' ':' '"' '\' '|' '*' '?' '<' '>'
*
Expand Down
Loading

0 comments on commit c6be89d

Please sign in to comment.