diff --git a/backend/lib/Logger/Logger.php b/backend/lib/Logger/Logger.php index a7a6989..07a8cb2 100644 --- a/backend/lib/Logger/Logger.php +++ b/backend/lib/Logger/Logger.php @@ -48,7 +48,8 @@ interface LoggerInterface { /** * * @author Steffen Vogel - * + * @package default + * @todo to be implemented */ abstract class Logger implements LoggerInterface { protected $request; diff --git a/backend/lib/Model/EntityDefinition.php b/backend/lib/Model/EntityDefinition.php index 3d01234..461d977 100644 --- a/backend/lib/Model/EntityDefinition.php +++ b/backend/lib/Model/EntityDefinition.php @@ -24,10 +24,8 @@ namespace Volkszaehler; /** - * * @author Steffen Vogel - * @todo extract to extra file - * + * @package default */ class EntityDefinition extends Util\Definition { /** @var string File containing the JSON definitons */ diff --git a/backend/lib/Model/PropertyDefinition.php b/backend/lib/Model/PropertyDefinition.php index 855131c..773f086 100644 --- a/backend/lib/Model/PropertyDefinition.php +++ b/backend/lib/Model/PropertyDefinition.php @@ -25,6 +25,10 @@ namespace Volkszaehler\Model; use Volkszaehler\Util; +/** + * @author Steffen Vogel + * @package default + */ class PropertyDefinition extends Util\Definition { /** One of: string, numeric, multiple */ public $type; diff --git a/backend/lib/Util/ClassLoader.php b/backend/lib/Util/ClassLoader.php index 8d2f2ec..e705e49 100644 --- a/backend/lib/Util/ClassLoader.php +++ b/backend/lib/Util/ClassLoader.php @@ -2,7 +2,6 @@ /** * @copyright Copyright (c) 2010, The volkszaehler.org project * @package util - * @author Steffen Vogel * @license http://www.opensource.org/licenses/gpl-license.php GNU Public License */ /* @@ -31,6 +30,7 @@ namespace Volkszaehler\Util; * * @package util * @author Roman Borschel + * @author Steffen Vogel * @license http://www.opensource.org/licenses/lgpl-license.php Lesser GNU Public License */ class ClassLoader { diff --git a/backend/lib/Util/JSON.php b/backend/lib/Util/JSON.php index 59a5394..da287dd 100644 --- a/backend/lib/Util/JSON.php +++ b/backend/lib/Util/JSON.php @@ -1,6 +1,6 @@ + * @package util * @copyright Copyright (c) 2010, The volkszaehler.org project * @license http://www.gnu.org/licenses/gpl.txt GNU Public License */ @@ -65,10 +65,23 @@ class JSON extends \ArrayObject { return $json; } + /** + * Cast to string + * + * @return string + */ public function __toString() { return $this->encode(); } + /** + * Formats json with indents and new lines + * + * @param string $json + * @param string $indent + * @param string $newLine + * @return string the formatted json + */ protected static function format($json, $indent = "\t", $newLine = "\n") { $formatted = ''; $indentLevel = 0; @@ -143,7 +156,7 @@ class JSON extends \ArrayObject { class JSONException extends \Exception { /** * @var array errorcodes defined by json_last_error() - * @url http://www.php.net/manual/en/json.constants.php + * @link http://www.php.net/manual/en/json.constants.php */ protected static $errors = array( JSON_ERROR_NONE => 'No error has occurred', diff --git a/backend/lib/Util/Random.php b/backend/lib/Util/Random.php index 916e277..57dc3f2 100644 --- a/backend/lib/Util/Random.php +++ b/backend/lib/Util/Random.php @@ -27,6 +27,7 @@ namespace Volkszaehler\Util; * Extensible PRNG * * @author Steffen Vogel + * @package util */ class Random { protected static $func = 'twister'; diff --git a/backend/volkszaehler.conf.default.php b/backend/volkszaehler.conf.default.php index 66a9f20..dcb31d3 100644 --- a/backend/volkszaehler.conf.default.php +++ b/backend/volkszaehler.conf.default.php @@ -29,37 +29,37 @@ /** * @var string PDO driver for Doctrine DBAL - * @url http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en#getting-a-connection:driver + * @link http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en#getting-a-connection:driver */ $config['db']['driver'] = 'pdo_mysql'; /** * @var string hostname of database server. Use 'localhost' for the machine your webserver is running on. - * @url http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en + * @link http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en */ $config['db']['host'] = 'localhost'; /** * @var string username for the database server - * @url http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en + * @link http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en */ $config['db']['user'] = 'vz'; /** * @var string password for the database server - * @url http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en + * @link http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en */ $config['db']['password'] = 'demo'; /** * @var string name of the database the backend should use - * @url http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en + * @link http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en */ $config['db']['dbname'] = 'volkszaehler'; /** * @var string path of the sqlite database - * @url http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en + * @link http://www.doctrine-project.org/projects/dbal/2.0/docs/reference/configuration/en */ //$config['db']['path'] = 'volkszaehler'; diff --git a/share/tests/configuration.php b/share/tests/configuration.php index a70300f..a96ee03 100644 --- a/share/tests/configuration.php +++ b/share/tests/configuration.php @@ -25,6 +25,7 @@ */ use Volkszaehler\Util; + include '../../backend/lib/Util/Configuration.php'; echo '
';
 
diff --git a/share/tools/generate_docs.php b/share/tools/generate_docs.php
index 12eb307..ae0a409 100644
--- a/share/tools/generate_docs.php
+++ b/share/tools/generate_docs.php
@@ -55,7 +55,7 @@ $output[] = $cmd . PHP_EOL;
 exec($cmd, $output, $rc);
 
 if ($rc == 0) {
-	# update dokumentation
+	# update documentation
 	$cmd = $vzDir . '/phpdoc/phpdoc -c ' . $vzDir . '/github/share/tools/phpdoc.ini';
 	//$cmd = 'php5 ' . $vzDir . '/phpdoctor/phpdoc.php ' . $vzDir . '/github/share/tools/phpdoctor.ini';
 	$output[] = PHP_EOL . $cmd . PHP_EOL;
diff --git a/share/tools/phpdoc.ini b/share/tools/phpdoc.ini
index 1c5a0b3..84703f9 100644
--- a/share/tools/phpdoc.ini
+++ b/share/tools/phpdoc.ini
@@ -86,7 +86,7 @@ directory = /var/www/vz/github
 ;; legal values: any wildcard strings separated by commas
 ;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value
 ;ignore = path/to/ignore*,*list.php,myfile.php,subdirectory/
-ignore = .git*,backend/lib/vendor/,backend/lib/Model/Proxies/
+ignore = .git*,backend/lib/vendor/,backend/lib/Model/Proxy/
 
 ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
 ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,