Skip to content

Commit

Permalink
Use see instead of link for references to structural elements
Browse files Browse the repository at this point in the history
  • Loading branch information
derrabus committed Dec 1, 2021
1 parent 2279779 commit d78267c
Show file tree
Hide file tree
Showing 53 changed files with 101 additions and 101 deletions.
10 changes: 5 additions & 5 deletions src/Connection.php
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ class Connection
protected $_eventManager;

/**
* @deprecated Use {@link createExpressionBuilder()} instead.
* @deprecated Use {@see createExpressionBuilder()} instead.
*
* @var ExpressionBuilder
*/
Expand Down Expand Up @@ -131,7 +131,7 @@ class Connection
/**
* The schema manager.
*
* @deprecated Use {@link createSchemaManager()} instead.
* @deprecated Use {@see createSchemaManager()} instead.
*
* @var AbstractSchemaManager|null
*/
Expand Down Expand Up @@ -291,7 +291,7 @@ public function createExpressionBuilder(): ExpressionBuilder
/**
* Gets the ExpressionBuilder for the connection.
*
* @deprecated Use {@link createExpressionBuilder()} instead.
* @deprecated Use {@see createExpressionBuilder()} instead.
*
* @return ExpressionBuilder
*/
Expand Down Expand Up @@ -785,7 +785,7 @@ public function quoteIdentifier($str)

/**
* The usage of this method is discouraged. Use prepared statements
* or {@link AbstractPlatform::quoteStringLiteral()} instead.
* or {@see AbstractPlatform::quoteStringLiteral()} instead.
*
* @param mixed $value
* @param int|string|Type|null $type
Expand Down Expand Up @@ -1528,7 +1528,7 @@ public function createSchemaManager(): AbstractSchemaManager
* Gets the SchemaManager that can be used to inspect or change the
* database schema through the connection.
*
* @deprecated Use {@link createSchemaManager()} instead.
* @deprecated Use {@see createSchemaManager()} instead.
*
* @return AbstractSchemaManager
*
Expand Down
4 changes: 2 additions & 2 deletions src/Driver/API/ExceptionConverter.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ interface ExceptionConverter
* Converts a given driver-level exception into a DBAL-level driver exception.
*
* Implementors should use the vendor-specific error code and SQLSTATE of the exception
* and instantiate the most appropriate specialized {@link DriverException} subclass.
* and instantiate the most appropriate specialized {@see DriverException} subclass.
*
* @param Exception $exception The driver exception to convert.
* @param Query|null $query The SQL query that triggered the exception, if any.
*
* @return DriverException An instance of {@link DriverException} or one of its subclasses.
* @return DriverException An instance of {@see DriverException} or one of its subclasses.
*/
public function convert(Exception $exception, ?Query $query): DriverException;
}
2 changes: 1 addition & 1 deletion src/Driver/AbstractDB2Driver.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
use function assert;

/**
* Abstract base implementation of the {@link Driver} interface for IBM DB2 based drivers.
* Abstract base implementation of the {@see Driver} interface for IBM DB2 based drivers.
*/
abstract class AbstractDB2Driver implements Driver
{
Expand Down
2 changes: 1 addition & 1 deletion src/Driver/AbstractException.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use Throwable;

/**
* Base implementation of the {@link Exception} interface.
* Base implementation of the {@see Exception} interface.
*
* @internal
*
Expand Down
2 changes: 1 addition & 1 deletion src/Driver/AbstractMySQLDriver.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
use function version_compare;

/**
* Abstract base implementation of the {@link Driver} interface for MySQL based drivers.
* Abstract base implementation of the {@see Driver} interface for MySQL based drivers.
*/
abstract class AbstractMySQLDriver implements VersionAwarePlatformDriver
{
Expand Down
2 changes: 1 addition & 1 deletion src/Driver/AbstractOracleDriver.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
use function assert;

/**
* Abstract base implementation of the {@link Driver} interface for Oracle based drivers.
* Abstract base implementation of the {@see Driver} interface for Oracle based drivers.
*/
abstract class AbstractOracleDriver implements Driver
{
Expand Down
2 changes: 1 addition & 1 deletion src/Driver/AbstractPostgreSQLDriver.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
use function version_compare;

/**
* Abstract base implementation of the {@link Driver} interface for PostgreSQL based drivers.
* Abstract base implementation of the {@see Driver} interface for PostgreSQL based drivers.
*/
abstract class AbstractPostgreSQLDriver implements VersionAwarePlatformDriver
{
Expand Down
2 changes: 1 addition & 1 deletion src/Driver/AbstractSQLServerDriver.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
use function assert;

/**
* Abstract base implementation of the {@link Driver} interface for Microsoft SQL Server based drivers.
* Abstract base implementation of the {@see Driver} interface for Microsoft SQL Server based drivers.
*/
abstract class AbstractSQLServerDriver implements Driver
{
Expand Down
2 changes: 1 addition & 1 deletion src/Driver/AbstractSQLiteDriver.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
use function assert;

/**
* Abstract base implementation of the {@link Doctrine\DBAL\Driver} interface for SQLite based drivers.
* Abstract base implementation of the {@see Doctrine\DBAL\Driver} interface for SQLite based drivers.
*/
abstract class AbstractSQLiteDriver implements Driver
{
Expand Down
2 changes: 1 addition & 1 deletion src/Driver/Connection.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public function query(string $sql): Result;
* Quotes a string for use in a query.
*
* The usage of this method is discouraged. Use prepared statements
* or {@link AbstractPlatform::quoteStringLiteral()} instead.
* or {@see AbstractPlatform::quoteStringLiteral()} instead.
*
* @param mixed $value
* @param int $type
Expand Down
2 changes: 1 addition & 1 deletion src/Driver/ServerInfoAwareConnection.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
/**
* Contract for a connection that is able to provide information about the server it is connected to.
*
* @deprecated The methods defined in this interface will be made part of the {@link Driver} interface
* @deprecated The methods defined in this interface will be made part of the {@see Driver} interface
* in the next major release.
*/
interface ServerInfoAwareConnection extends Connection
Expand Down
8 changes: 4 additions & 4 deletions src/Driver/Statement.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ interface Statement
* this will be a parameter name of the form :name. For a prepared statement
* using question mark placeholders, this will be the 1-indexed position of the parameter.
* @param mixed $value The value to bind to the parameter.
* @param int $type Explicit data type for the parameter using the {@link ParameterType}
* @param int $type Explicit data type for the parameter using the {@see ParameterType}
* constants.
*
* @return bool TRUE on success or FALSE on failure.
Expand All @@ -31,7 +31,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING);

/**
* Binds a PHP variable to a corresponding named (not supported by mysqli driver, see comment below) or question
* mark placeholder in the SQL statement that was use to prepare the statement. Unlike {@link bindValue()},
* mark placeholder in the SQL statement that was use to prepare the statement. Unlike {@see bindValue()},
* the variable is bound as a reference and will only be evaluated at the time
* that PDOStatement->execute() is called.
*
Expand All @@ -47,7 +47,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING);
* this will be a parameter name of the form :name. For a prepared statement using
* question mark placeholders, this will be the 1-indexed position of the parameter.
* @param mixed $variable Name of the PHP variable to bind to the SQL statement parameter.
* @param int $type Explicit data type for the parameter using the {@link ParameterType}
* @param int $type Explicit data type for the parameter using the {@see ParameterType}
* constants.
* @param int|null $length You must specify maxlength when using an OUT bind
* so that PHP allocates enough memory to hold the returned value.
Expand All @@ -62,7 +62,7 @@ public function bindParam($param, &$variable, $type = ParameterType::STRING, $le
* Executes a prepared statement
*
* If the prepared statement included parameter markers, you must either:
* call {@link bindParam()} to bind PHP variables to the parameter markers:
* call {@see bindParam()} to bind PHP variables to the parameter markers:
* bound variables pass their value as input and receive the output value,
* if any, of their associated parameter markers or pass an array of input-only
* parameter values.
Expand Down
12 changes: 6 additions & 6 deletions src/DriverManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
use function substr;

/**
* Factory for creating {@link Connection} instances.
* Factory for creating {@see Connection} instances.
*
* @psalm-type OverrideParams = array{
* charset?: string,
Expand Down Expand Up @@ -71,7 +71,7 @@ final class DriverManager
/**
* List of supported drivers and their mappings to the driver classes.
*
* To add your own driver use the 'driverClass' parameter to {@link DriverManager::getConnection()}.
* To add your own driver use the 'driverClass' parameter to {@see DriverManager::getConnection()}.
*/
private const DRIVER_MAP = [
'pdo_mysql' => PDO\MySQL\Driver::class,
Expand Down Expand Up @@ -118,7 +118,7 @@ private function __construct()
*
* $params must contain at least one of the following.
*
* Either 'driver' with one of the array keys of {@link DRIVER_MAP},
* Either 'driver' with one of the array keys of {@see DRIVER_MAP},
* OR 'driverClass' that contains the full class name (with namespace) of the
* driver class to instantiate.
*
Expand Down Expand Up @@ -340,7 +340,7 @@ private static function parseDatabaseUrl(array $params): array
* Parses the given connection URL and resolves the given connection parameters.
*
* Assumes that the connection URL scheme is already parsed and resolved into the given connection parameters
* via {@link parseDatabaseUrlScheme}.
* via {@see parseDatabaseUrlScheme}.
*
* @see parseDatabaseUrlScheme
*
Expand Down Expand Up @@ -394,7 +394,7 @@ private static function parseDatabaseUrlQuery(array $url, array $params): array
/**
* Parses the given regular connection URL and resolves the given connection parameters.
*
* Assumes that the "path" URL part is already normalized via {@link normalizeDatabaseUrlPath}.
* Assumes that the "path" URL part is already normalized via {@see normalizeDatabaseUrlPath}.
*
* @see normalizeDatabaseUrlPath
*
Expand All @@ -413,7 +413,7 @@ private static function parseRegularDatabaseUrlPath(array $url, array $params):
/**
* Parses the given SQLite connection URL and resolves the given connection parameters.
*
* Assumes that the "path" URL part is already normalized via {@link normalizeDatabaseUrlPath}.
* Assumes that the "path" URL part is already normalized via {@see normalizeDatabaseUrlPath}.
*
* @see normalizeDatabaseUrlPath
*
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaAlterTableAddColumnEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
use function is_array;

/**
* Event Arguments used when SQL queries for adding table columns are generated inside {@link AbstractPlatform}.
* Event Arguments used when SQL queries for adding table columns are generated inside {@see AbstractPlatform}.
*/
class SchemaAlterTableAddColumnEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaAlterTableChangeColumnEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
use function is_array;

/**
* Event Arguments used when SQL queries for changing table columns are generated inside {@link AbstractPlatform}.
* Event Arguments used when SQL queries for changing table columns are generated inside {@see AbstractPlatform}.
*/
class SchemaAlterTableChangeColumnEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaAlterTableEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
use function is_array;

/**
* Event Arguments used when SQL queries for creating tables are generated inside {@link AbstractPlatform}.
* Event Arguments used when SQL queries for creating tables are generated inside {@see AbstractPlatform}.
*/
class SchemaAlterTableEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaAlterTableRemoveColumnEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
use function is_array;

/**
* Event Arguments used when SQL queries for removing table columns are generated inside {@link AbstractPlatform}.
* Event Arguments used when SQL queries for removing table columns are generated inside {@see AbstractPlatform}.
*/
class SchemaAlterTableRemoveColumnEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaAlterTableRenameColumnEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
use function is_array;

/**
* Event Arguments used when SQL queries for renaming table columns are generated inside {@link AbstractPlatform}.
* Event Arguments used when SQL queries for renaming table columns are generated inside {@see AbstractPlatform}.
*/
class SchemaAlterTableRenameColumnEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaColumnDefinitionEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
use Doctrine\DBAL\Schema\Column;

/**
* Event Arguments used when the portable column definition is generated inside {@link AbstractPlatform}.
* Event Arguments used when the portable column definition is generated inside {@see AbstractPlatform}.
*/
class SchemaColumnDefinitionEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaCreateTableColumnEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
use function is_array;

/**
* Event Arguments used when SQL queries for creating table columns are generated inside {@link AbstractPlatform}.
* Event Arguments used when SQL queries for creating table columns are generated inside {@see AbstractPlatform}.
*/
class SchemaCreateTableColumnEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaCreateTableEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
use function is_array;

/**
* Event Arguments used when SQL queries for creating tables are generated inside {@link AbstractPlatform}.
* Event Arguments used when SQL queries for creating tables are generated inside {@see AbstractPlatform}.
*/
class SchemaCreateTableEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaDropTableEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
use InvalidArgumentException;

/**
* Event Arguments used when the SQL query for dropping tables are generated inside {@link AbstractPlatform}.
* Event Arguments used when the SQL query for dropping tables are generated inside {@see AbstractPlatform}.
*/
class SchemaDropTableEventArgs extends SchemaEventArgs
{
Expand Down
2 changes: 1 addition & 1 deletion src/Event/SchemaIndexDefinitionEventArgs.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
use Doctrine\DBAL\Schema\Index;

/**
* Event Arguments used when the portable index definition is generated inside {@link AbstractSchemaManager}.
* Event Arguments used when the portable index definition is generated inside {@see AbstractSchemaManager}.
*/
class SchemaIndexDefinitionEventArgs extends SchemaEventArgs
{
Expand Down
4 changes: 2 additions & 2 deletions src/Logging/SQLLogger.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
/**
* Interface for SQL loggers.
*
* @deprecated Use {@link \Doctrine\DBAL\Logging\Middleware} or implement
* {@link \Doctrine\DBAL\Driver\Middleware} instead.
* @deprecated Use {@see \Doctrine\DBAL\Logging\Middleware} or implement
* {@see \Doctrine\DBAL\Driver\Middleware} instead.
*/
interface SQLLogger
{
Expand Down
14 changes: 7 additions & 7 deletions src/Platforms/AbstractPlatform.php
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ public function getBinaryDefaultLength()
/**
* Gets all SQL wildcard characters of the platform.
*
* @deprecated Use {@link AbstractPlatform::getLikeWildcardCharacters()} instead.
* @deprecated Use {@see AbstractPlatform::getLikeWildcardCharacters()} instead.
*
* @return string[]
*/
Expand Down Expand Up @@ -1657,7 +1657,7 @@ public function getDropIndexSQL($index, $table = null)
/**
* Returns the SQL to drop a constraint.
*
* @internal The method should be only used from within the {@link AbstractPlatform} class hierarchy.
* @internal The method should be only used from within the {@see AbstractPlatform} class hierarchy.
*
* @param Constraint|string $constraint
* @param Table|string $table
Expand Down Expand Up @@ -1980,8 +1980,8 @@ public function getDropSequenceSQL($sequence)
/**
* Returns the SQL to create a constraint on a table on this platform.
*
* @deprecated Use {@link getCreateIndexSQL()}, {@link getCreateForeignKeySQL()}
* or {@link getCreateUniqueConstraintSQL()} instead.
* @deprecated Use {@see getCreateIndexSQL()}, {@see getCreateForeignKeySQL()}
* or {@see getCreateUniqueConstraintSQL()} instead.
*
* @param Table|string $table
*
Expand Down Expand Up @@ -3028,7 +3028,7 @@ public function getListDatabasesSQL()
/**
* Returns the SQL statement for retrieving the namespaces defined in the database.
*
* @deprecated Use {@link AbstractSchemaManager::listSchemaNames()} instead.
* @deprecated Use {@see AbstractSchemaManager::listSchemaNames()} instead.
*
* @return string
*
Expand Down Expand Up @@ -3511,7 +3511,7 @@ public function supportsSchemas()
* @deprecated
*
* Platforms that either support or emulate schemas don't automatically
* filter a schema for the namespaced elements in {@link AbstractManager::createSchema()}.
* filter a schema for the namespaced elements in {@see AbstractManager::createSchema()}.
*
* @return bool
*/
Expand Down Expand Up @@ -3879,7 +3879,7 @@ protected function createReservedKeywordsList(): KeywordList
/**
* Returns the class name of the reserved keywords list.
*
* @deprecated Implement {@link createReservedKeywordsList()} instead.
* @deprecated Implement {@see createReservedKeywordsList()} instead.
*
* @return string
* @psalm-return class-string<KeywordList>
Expand Down
2 changes: 1 addition & 1 deletion src/Platforms/DB2Platform.php
Original file line number Diff line number Diff line change
Expand Up @@ -879,7 +879,7 @@ public function supportsSavepoints()
/**
* {@inheritDoc}
*
* @deprecated Implement {@link createReservedKeywordsList()} instead.
* @deprecated Implement {@see createReservedKeywordsList()} instead.
*/
protected function getReservedKeywordsClass()
{
Expand Down

0 comments on commit d78267c

Please sign in to comment.