Fix docblock typos in DriverManager docs

[CHItA]

Q	A
Type	documentation
BC Break	no
Fixed issues	none

Summary

In the api docs the names of the drivers are incorrect. Also, could someone confirm that the (unstable) annotations are still correct?

[morozov]

@CHItA thanks for the update. The ibm_db2 driver is pretty much stable. The (unstable) annotation should definitely be removed from there. As for pdo_oci, it is usable and we continuously test against it. In the end, it's the consumer's call which driver to use.

I'd remove the (unstable) annotation from everywhere and sort the drivers alphabetically.

[morozov]

Hm… it actually duplicates the keys of the driver map. Would it make sense to reference if using {@link $_driverMap} instead of duplication?

dbal/lib/Doctrine/DBAL/DriverManager.php

Lines 46 to 58 in 3d6d354

	private static $_driverMap = [
	'pdo_mysql' => PDOMySQLDriver::class,
	'pdo_sqlite' => PDOSQLiteDriver::class,
	'pdo_pgsql' => PDOPgSQLDriver::class,
	'pdo_oci' => PDOOCIDriver::class,
	'oci8' => OCI8Driver::class,
	'ibm_db2' => DB2Driver::class,
	'pdo_sqlsrv' => PDOSQLSrvDriver::class,
	'mysqli' => MySQLiDriver::class,
	'drizzle_pdo_mysql' => DrizzlePDOMySQLDriver::class,
	'sqlanywhere' => SQLAnywhereDriver::class,
	'sqlsrv' => SQLSrvDriver::class,
	];

[CHItA]

True, I am fine with whatever. Although $_driverMap doesn't seem to be listed in the API docs, which I would consider to be quite useful.

[CHItA]

One more note, then I'll be happy to push whatever you find to be the best solution:
a) Which one of these would you prefer? Using a {@link $_driverMap} or just linking to the getAvailableDrivers() function which returns the keys of this array.
b) The docblock has no return value annotation so if I'm here, I might as well fix that too. Should I?

Also, what is your commit squashing policy? Three commits feel a bit much for a one line documentation change.

[morozov]

Which one of these would you prefer?

{@link $_driverMap} seems like a more reasonable reference. It contains the actual values we're referring to.

The docblock has no return value annotation […]

Which one?

Also, what is your commit squashing policy? Three commits feel a bit much for a one line documentation change.

We usually squash commits unless they provide additional clarity to the changes (not the case here).

[CHItA]

Oh, and getConnection() is missing the return statement.

[morozov]

Thanks, @CHItA!

[CHItA]

@morozov No worries, thank you for maintaining Doctrine! :)