diff options
| author | Juuso Lapinlampi <wub@partyvan.eu> | 2016-05-23 23:02:39 +0200 |
|---|---|---|
| committer | Juuso Lapinlampi <wub@partyvan.eu> | 2016-05-24 21:19:22 +0200 |
| commit | 2fc3fbb41dbd81a92dfe27a22b31f36b10ea37ca (patch) | |
| tree | 297dc3ab4da5a88e1fbbc87cefd4b9a96dd2ca11 /static/classes/UploadException.class.php | |
| parent | c5c588311bf6da7979a67e405563c3d2fba95094 (diff) | |
Extend and improve PHP code comments (PHPDoc)
Add file summaries, @copyright tags and other comments. Covers majority
of the PHP code base now. I have avoided being too verbose and omitted
some potential tags.
Most visibly to the user, this comments every user configurable setting
and clarifies what some of the options do.
POMF_DB_USER and POMF_DB_PASS are not rendered perfectly in
phpDocumentor version 2.8.5. This is a sacrifice I made in attempt for
not being too verbose and obvious.
Response class gets a @todo for being a god object.
Diffstat (limited to 'static/classes/UploadException.class.php')
| -rwxr-xr-x | static/classes/UploadException.class.php | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/static/classes/UploadException.class.php b/static/classes/UploadException.class.php index dbe47eb..7740ee6 100755 --- a/static/classes/UploadException.class.php +++ b/static/classes/UploadException.class.php @@ -1,6 +1,11 @@ <?php /** + * Returns a human readable error description for file upload errors. + * + * @author Dan Brown <danbrown@php.net> + * @author Michiel Thalen + * @copyright * -------------------------------------------------------------------- * The PHP License, version 3.01 * Copyright (c) 1999 - 2014 The PHP Group. All rights reserved. @@ -71,9 +76,6 @@ * <http://www.zend.com>. */ -// Exception class extension from: http://php.net/manual/en/features.file-upload.errors.php#89374 -// Handles files error returning a proper error description - class UploadException extends Exception { public function __construct($code) |