summaryrefslogtreecommitdiff
path: root/static/upload.php
diff options
context:
space:
mode:
authorJuuso Lapinlampi <wub@partyvan.eu>2016-05-23 23:02:39 +0200
committerJuuso Lapinlampi <wub@partyvan.eu>2016-05-24 21:19:22 +0200
commit2fc3fbb41dbd81a92dfe27a22b31f36b10ea37ca (patch)
tree297dc3ab4da5a88e1fbbc87cefd4b9a96dd2ca11 /static/upload.php
parentc5c588311bf6da7979a67e405563c3d2fba95094 (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/upload.php')
-rw-r--r--static/upload.php12
1 files changed, 8 insertions, 4 deletions
diff --git a/static/upload.php b/static/upload.php
index 4bee979..b8fb46a 100644
--- a/static/upload.php
+++ b/static/upload.php
@@ -1,10 +1,14 @@
<?php
/**
- * Copyright (c) 2013, 2014 Peter Lejeck <peter.lejeck@gmail.com>
- * Copyright (c) 2013, 2014, 2015 Eric Johansson <neku@pomf.se>
- * Copyright (c) 2015 cenci0 <alchimist94@gmail.com>
- * Copyright (c) 2015, 2016 the Pantsu.cat developers <hostmaster@pantsu.cat>
+ * Handles POST uploads, generates filenames, moves files around and commits
+ * uploaded metadata to database.
+ *
+ * @copyright Copyright (c) 2013, 2014 Peter Lejeck <peter.lejeck@gmail.com>
+ * @copyright Copyright (c) 2013, 2014, 2015 Eric Johansson <neku@pomf.se>
+ * @copyright Copyright (c) 2015 cenci0 <alchimist94@gmail.com>
+ * @copyright Copyright (c) 2015, 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