Merge branch 'wub/php-improve-comments'

- Extend and improve PHP code comments (PHPDoc)
- Add Pantsu.cat copyright year 2016 for recent change
- UploadedFile: Fix typo SHA1 to SHA-1
- Response: Clarify what http_response_code(200); is

Reviewed-by: Austin Gillmann <alucard@cuntflaps.me>

1 files changed, 12 insertions, 4 deletions

diff --git a/static/classes/UploadedFile.class.php b/static/classes/UploadedFile.class.php
index 99020ce..20d42b3 100644
--- a/static/classes/UploadedFile.class.php
+++ b/static/classes/UploadedFile.class.php
@@ -1,7 +1,11 @@
 <?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>
+ * @copyright Copyright (c) 2016 the Pantsu.cat developers
+ * <hostmaster@pantsu.cat>
  *
  * 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 +35,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.
+     * Generates the SHA-1 or returns the cached SHA-1 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()
     {