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/UploadedFile.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/UploadedFile.class.php')
| -rw-r--r-- | static/classes/UploadedFile.class.php | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/static/classes/UploadedFile.class.php b/static/classes/UploadedFile.class.php index 99020ce..1149581 100644 --- a/static/classes/UploadedFile.class.php +++ b/static/classes/UploadedFile.class.php @@ -1,7 +1,9 @@ <?php /** - * Copyright (c) 2013, 2014 Peter Lejeck <peter.lejeck@gmail.com> + * Returns information about uploaded files. + * + * @copyright Copyright (c) 2013, 2014 Peter Lejeck <peter.lejeck@gmail.com> * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -31,14 +33,18 @@ class UploadedFile public $tempfile; public $error; - /* Cached checksums */ + /** + * SHA-1 checksum + * + * @var string 40 digit hexadecimal hash (160 bits) + */ private $sha1; /** * Generates the SHA1 or returns the cached SHA1 hash for the file. * * @deprecated 2.1.0 To be replaced with SHA-256 hashing. - * @return string + * @return string|false $sha1 */ public function get_sha1() { |