Fix docs and variable names.

Add missing docs and fix gross klassName vars.

src/Core/StaticConfigTrait.php

@@ -141,22 +141,21 @@ trait StaticConfigTrait {
  * The following is an example of its usage:
  *
  * {{{
- *   $dsn = 'mysql://user:pass@localhost/database?';
- *   $config = ConnectionManager::parseDsn($dsn);
+ * $dsn = 'mysql://user:pass@localhost/database?';
+ * $config = ConnectionManager::parseDsn($dsn);
  *
- *   $dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
- * 	 $config = Log::parseDsn($dsn);
+ * $dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
+ * $config = Log::parseDsn($dsn);
  *
- *   $dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
- * 	 $config = Email::parseDsn($dsn);
+ * $dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
+ * $config = Email::parseDsn($dsn);
  *
- *   $dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
- * 	 $config = Cache::parseDsn($dsn);
+ * $dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
+ * $config = Cache::parseDsn($dsn);
  *
- *   $dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
- * 	 $config = Cache::parseDsn($dsn);
- *
- * }}
+ * $dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
+ * $config = Cache::parseDsn($dsn);
+ * }}}
  *
  * For all classes, the value of `scheme` is set as the value of both the `className`
  * unless they have been otherwise specified.

src/Datasource/ConnectionManager.php

@@ -73,15 +73,15 @@ class ConnectionManager {
  * The following is an example of its usage:
  *
  * {{{
- *   $dsn = 'mysql://user:pass@localhost/database';
- *   $config = ConnectionManager::parseDsn($dsn);
+ * $dsn = 'mysql://user:pass@localhost/database';
+ * $config = ConnectionManager::parseDsn($dsn);
  *
- *   $dsn = 'Cake\Database\Driver\Mysql://localhost:3306/database?className=Cake\Database\Connection';
- *   $config = ConnectionManager::parseDsn($dsn);
+ * $dsn = 'Cake\Database\Driver\Mysql://localhost:3306/database?className=Cake\Database\Connection';
+ * $config = ConnectionManager::parseDsn($dsn);
  *
- *   $dsn = 'Cake\Database\Connection://localhost:3306/database?driver=Cake\Database\Driver\Mysql';
- *   $config = ConnectionManager::parseDsn($dsn);
- * }}
+ * $dsn = 'Cake\Database\Connection://localhost:3306/database?driver=Cake\Database\Driver\Mysql';
+ * $config = ConnectionManager::parseDsn($dsn);
+ * }}}
  *
  * For all classes, the value of `scheme` is set as the value of both the `className` and `driver`
  * unless they have been otherwise specified.

tests/TestCase/Core/StaticConfigTraitTest.php

@@ -26,6 +26,12 @@ class TestConnectionManagerStaticConfig {
 		parseDsn as protected _parseDsn;
 	}
 
+/**
+ * Parse a DSN
+ *
+ * @param string $config The config to parse.
+ * @return array
+ */
 	public static function parseDsn($config = null) {
 		$config = static::_parseDsn($config);
 
@@ -42,6 +48,11 @@ class TestConnectionManagerStaticConfig {
 		return $config;
 	}
 
+/**
+ * Database driver class map.
+ *
+ * @return array
+ */
 	public static function getClassMap() {
 		return [
 			'mysql' => 'Cake\Database\Driver\Mysql',
@@ -60,6 +71,11 @@ class TestCacheStaticConfig {
 
 	use StaticConfigTrait;
 
+/**
+ * Cache driver class map.
+ *
+ * @return array
+ */
 	public static function getClassMap() {
 		return [
 			'apc' => 'Cake\Cache\Engine\ApcEngine',
@@ -81,6 +97,11 @@ class TestEmailStaticConfig {
 
 	use StaticConfigTrait;
 
+/**
+ * Email driver class map.
+ *
+ * @return array
+ */
 	public static function getClassMap() {
 		return [
 			'debug' => 'Cake\Network\Email\DebugTransport',
@@ -98,6 +119,11 @@ class TestLogStaticConfig {
 
 	use StaticConfigTrait;
 
+/**
+ * Log engine class map.
+ *
+ * @return array
+ */
 	public static function getClassMap() {
 		return [
 			'console' => 'Cake\Log\Engine\ConsoleLog',
@@ -114,11 +140,21 @@ class TestLogStaticConfig {
  */
 class StaticConfigTraitTest extends TestCase {
 
+/**
+ * setup method
+ *
+ * @return void
+ */
 	public function setUp() {
 		parent::setUp();
 		$this->subject = $this->getObjectForTrait('Cake\Core\StaticConfigTrait');
 	}
 
+/**
+ * teardown method
+ *
+ * @return void
+ */
 	public function tearDown() {
 		unset($this->subject);
 		parent::tearDown();
@@ -130,9 +166,8 @@ class StaticConfigTraitTest extends TestCase {
  * @return void
  */
 	public function testSimpleParseDsn() {
-		$klassName = get_class($this->subject);
-
-		$this->assertSame([], $klassName::parseDsn(''));
+		$className = get_class($this->subject);
+		$this->assertSame([], $className::parseDsn(''));
 	}
 
 /**
@@ -142,8 +177,8 @@ class StaticConfigTraitTest extends TestCase {
  * @return void
  */
 	public function testParseBadType() {
-		$klassName = get_class($this->subject);
-		$klassName::parseDsn(['url' => 'http://:80']);
+		$className = get_class($this->subject);
+		$className::parseDsn(['url' => 'http://:80']);
 	}
 
 /**
@@ -385,4 +420,3 @@ class StaticConfigTraitTest extends TestCase {
 	}
 
 }
-