Add class-level docblock to every file.

PHPCI/Command/GenerateCommand.php

@@ -15,6 +15,12 @@ use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+/**
+* Generate console command - Reads the database and generates models and stores.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Console
+*/
 class GenerateCommand extends Command
 {
     protected function configure()

PHPCI/Command/InstallCommand.php

@@ -17,6 +17,12 @@ use Symfony\Component\Console\Output\OutputInterface;
 use b8\Store\Factory;
 use PHPCI\Builder;
 
+/**
+* Install console command - Installs PHPCI.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Console
+*/
 class InstallCommand extends Command
 {
     protected function configure()

PHPCI/Command/RunCommand.php

@@ -18,6 +18,12 @@ use b8\Store\Factory;
 use PHPCI\Builder,
     PHPCI\BuildFactory;
 
+/**
+* Run console command - Runs any pending builds.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Console
+*/
 class RunCommand extends Command
 {
     protected function configure()

PHPCI/Controller/BitbucketController.php

@@ -12,7 +12,12 @@ use b8,
 	b8\Store,
 	PHPCI\Model\Build;
 
-
+/**
+* BitBucket Controller - Processes webhook pings from BitBucket.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Web
+*/
 class BitbucketController extends b8\Controller
 {
 	public function init()

PHPCI/Controller/BuildController.php

@@ -12,6 +12,12 @@ use b8,
 	b8\Registry,
 	PHPCI\Model\Build;
 
+/**
+* Build Controller - Allows users to run and view builds.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Web
+*/
 class BuildController extends b8\Controller
 {
 	public function init()

PHPCI/Controller/GithubController.php

@@ -12,7 +12,12 @@ use b8,
 	b8\Store,
 	PHPCI\Model\Build;
 
-
+/**
+* Github Controller - Processes webhook pings from Github.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Web
+*/
 class GithubController extends b8\Controller
 {
 	public function init()

PHPCI/Controller/IndexController.php

@@ -10,6 +10,12 @@
 namespace PHPCI\Controller;
 use b8;
 
+/**
+* Index Controller - Displays the PHPCI Dashboard.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Web
+*/
 class IndexController extends b8\Controller
 {
 	public function init()

PHPCI/Controller/ProjectController.php

@@ -14,6 +14,12 @@ use b8,
 	b8\Form,
 	b8\Registry;
 
+/**
+* Project Controller - Allows users to create, edit and view projects.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Web
+*/
 class ProjectController extends b8\Controller
 {
 	public function init()

PHPCI/Controller/SessionController.php

@@ -10,6 +10,12 @@
 namespace PHPCI\Controller;
 use b8;
 
+/**
+* Session Controller - Handles user login / logout.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Web
+*/
 class SessionController extends b8\Controller
 {
 	public function init()

PHPCI/Controller/UserController.php

@@ -13,6 +13,12 @@ use b8,
 	PHPCI\Model\User,
 	b8\Form;
 
+/**
+* User Controller - Allows an administrator to view, add, edit and delete users.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Web
+*/
 class UserController extends b8\Controller
 {
 	public function init()

PHPCI/Helper/User.php

@@ -9,6 +9,12 @@
 
 namespace PHPCI\Helper;
 
+/**
+* User Helper - Provides access to logged in user information in views.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Web
+*/
 class User
 {
 	public function __call($method, $params = array())

PHPCI/Model/Build.php

@@ -15,9 +15,12 @@ use PHPCI\Model\Base\BuildBase,
 	PHPCI\Builder;
 
 /**
- * Build Model
+* Build Model
- * @uses PHPCI\Model\Base\BuildBase
+* @uses			PHPCI\Model\Base\BuildBase
- */
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Core
+*/
 class Build extends BuildBase
 {
 	public function getCommitLink()

PHPCI/Model/Build/BitbucketBuild.php

@@ -8,13 +8,15 @@
 */
 
 namespace PHPCI\Model\Build;
-use PHPCI\Model\Build;
+use PHPCI\Model\Build,
-use PHPCI\Model\Build\RemoteGitBuild;
+	PHPCI\Model\Build\RemoteGitBuild;
 
 /**
- * BitBucket Build Model
+* BitBucket Build Model
- * @uses PHPCI\Model\Build
+* @author       Dan Cryer <dan@block8.co.uk>
- */
+* @package      PHPCI
+* @subpackage   Core
+*/
 class BitbucketBuild extends RemoteGitBuild
 {
 	public function getCommitLink()

PHPCI/Model/Build/GithubBuild.php

@@ -11,9 +11,11 @@ namespace PHPCI\Model\Build;
 use PHPCI\Model\Build\RemoteGitBuild;
 
 /**
- * Github Build Model
+* Github Build Model
- * @uses PHPCI\Model\Build
+* @author       Dan Cryer <dan@block8.co.uk>
- */
+* @package      PHPCI
+* @subpackage   Core
+*/
 class GithubBuild extends RemoteGitBuild
 {
 	public function getCommitLink()

PHPCI/Model/Build/LocalBuild.php

@@ -8,14 +8,16 @@
 */
 
 namespace PHPCI\Model\Build;
-use PHPCI\Model\Build;
+use PHPCI\Model\Build,
-use Symfony\Component\Yaml\Parser as YamlParser;
+	PHPCI\Builder,
-use PHPCI\Builder;
+	Symfony\Component\Yaml\Parser as YamlParser;
 
 /**
- * Local Build Model
+* Local Build Model
- * @uses PHPCI\Model\Build
+* @author       Dan Cryer <dan@block8.co.uk>
- */
+* @package      PHPCI
+* @subpackage   Core
+*/
 class LocalBuild extends Build
 {
 	public function createWorkingCopy(Builder $builder, $buildPath)

PHPCI/Model/Build/RemoteGitBuild.php

@@ -8,14 +8,16 @@
 */
 
 namespace PHPCI\Model\Build;
-use PHPCI\Model\Build;
+use PHPCI\Model\Build,
-use PHPCI\Builder;
+	PHPCI\Builder,
-use Symfony\Component\Yaml\Parser as YamlParser;
+	Symfony\Component\Yaml\Parser as YamlParser;
 
 /**
- * Remote Build Model
+* Remote Git Build Model
- * @uses PHPCI\Model\Build
+* @author       Dan Cryer <dan@block8.co.uk>
- */
+* @package      PHPCI
+* @subpackage   Core
+*/
 abstract class RemoteGitBuild extends Build
 {
 	abstract protected function getCloneUrl();

PHPCI/Model/Project.php

@@ -14,9 +14,12 @@ require_once(APPLICATION_PATH . 'PHPCI/Model/Base/ProjectBase.php');
 use PHPCI\Model\Base\ProjectBase;
 
 /**
- * Project Model
+* Project Model
- * @uses PHPCI\Model\Base\ProjectBase
+* @uses			PHPCI\Model\Base\ProjectBase
- */
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Core
+*/
 class Project extends ProjectBase
 {
 }

PHPCI/Model/User.php

@@ -14,9 +14,12 @@ require_once(APPLICATION_PATH . 'PHPCI/Model/Base/UserBase.php');
 use PHPCI\Model\Base\UserBase;
 
 /**
- * User Model
+* User Model
- * @uses PHPCI\Model\Base\UserBase
+* @uses			PHPCI\Model\Base\UserBase
- */
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Core
+*/
 class User extends UserBase
 {
 	// This class has been left blank so that you can modify it - changes in this file will not be overwritten.

PHPCI/Plugin/Composer.php

@@ -9,6 +9,12 @@
 
 namespace PHPCI\Plugin;
 
+/**
+* Composer Plugin - Provides access to Composer functionality.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
 class Composer implements \PHPCI\Plugin
 {
 	protected $directory;

PHPCI/Plugin/Mysql.php

@@ -10,6 +10,12 @@
 namespace PHPCI\Plugin;
 use PDO;
 
+/**
+* MySQL Plugin - Provides access to a MySQL database.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
 class Mysql implements \PHPCI\Plugin
 {
 	protected $phpci;

PHPCI/Plugin/Pgsql.php

@@ -10,6 +10,12 @@
 namespace PHPCI\Plugin;
 use PDO;
 
+/**
+* PgSQL Plugin - Provides access to a PgSQL database.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
 class Pgsql implements \PHPCI\Plugin
 {
 	protected $phpci;

PHPCI/Plugin/PhpCodeSniffer.php

@@ -9,6 +9,12 @@
 
 namespace PHPCI\Plugin;
 
+/**
+* PHP Code Sniffer Plugin - Allows PHP Code Sniffer testing.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
 class PhpCodeSniffer implements \PHPCI\Plugin
 {
 	protected $directory;

PHPCI/Plugin/PhpCpd.php

@@ -9,6 +9,12 @@
 
 namespace PHPCI\Plugin;
 
+/**
+* PHP Copy / Paste Detector - Allows PHP Copy / Paste Detector testing.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
 class PhpCpd implements \PHPCI\Plugin
 {
 	protected $directory;

PHPCI/Plugin/PhpMessDetector.php

@@ -9,6 +9,12 @@
 
 namespace PHPCI\Plugin;
 
+/**
+* PHP Mess Detector Plugin - Allows PHP Mess Detector testing.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
 class PhpMessDetector implements \PHPCI\Plugin
 {
 	protected $directory;

PHPCI/Plugin/PhpSpec.php

@@ -9,6 +9,12 @@
 
 namespace PHPCI\Plugin;
 
+/**
+* PHP Spec Plugin - Allows PHP Spec testing.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
 class PhpSpec implements \PHPCI\Plugin
 {
 	protected $phpci;

PHPCI/Plugin/PhpUnit.php

@@ -9,6 +9,12 @@
 
 namespace PHPCI\Plugin;
 
+/**
+* PHP Unit Plugin - Allows PHP Unit testing.
+* @author       Dan Cryer <dan@block8.co.uk>
+* @package      PHPCI
+* @subpackage   Plugins
+*/
 class PhpUnit implements \PHPCI\Plugin
 {
 	protected $args;

PHPCI/Store/ProjectStore.php

@@ -14,9 +14,11 @@ require_once(APPLICATION_PATH . 'PHPCI/Store/Base/ProjectStoreBase.php');
 use PHPCI\Store\Base\ProjectStoreBase;
 
 /**
- * Project Store
+* Project Store
- * @uses PHPCI\Store\Base\ProjectStoreBase
+* @author       Dan Cryer <dan@block8.co.uk>
- */
+* @package      PHPCI
+* @subpackage   Core
+*/
 class ProjectStore extends ProjectStoreBase
 {
 	// This class has been left blank so that you can modify it - changes in this file will not be overwritten.

PHPCI/Store/UserStore.php

@@ -1,8 +1,11 @@
 <?php
-
 /**
- * User store for table: user
+* PHPCI - Continuous Integration for PHP
- */
+*
+* @copyright    Copyright 2013, Block 8 Limited.
+* @license      https://github.com/Block8/PHPCI/blob/master/LICENSE.md
+* @link         http://www.phptesting.org/
+*/
 
 namespace PHPCI\Store;
 
@@ -11,9 +14,11 @@ require_once(APPLICATION_PATH . 'PHPCI/Store/Base/UserStoreBase.php');
 use PHPCI\Store\Base\UserStoreBase;
 
 /**
- * User Store
+* User Store
- * @uses PHPCI\Store\Base\UserStoreBase
+* @author       Dan Cryer <dan@block8.co.uk>
- */
+* @package      PHPCI
+* @subpackage   Core
+*/
 class UserStore extends UserStoreBase
 {
 	// This class has been left blank so that you can modify it - changes in this file will not be overwritten.