Permalink
Browse files

! Fix many of the phpdocumentor errors with our docblock's

  Many files, many to go ! fun fun fun, don't miss out

Signed-off-by: Spuds <spuds@simplemachines.org>
  • Loading branch information...
1 parent 2591618 commit c8e62fe0292024e9b55a2b149d5f99ac68db3535 @Spuds Spuds committed Oct 11, 2012
Showing with 1,006 additions and 331 deletions.
  1. +3 −1 Packages/index.php
  2. +3 −1 Smileys/index.php
  3. +21 −6 Sources/Class-BrowserDetect.php
  4. +27 −21 Sources/Class-CurlFetchWeb.php
  5. +145 −12 Sources/Class-Package.php
  6. +6 −4 Sources/DbExtra-mysql.php
  7. +7 −5 Sources/DbExtra-postgresql.php
  8. +7 −5 Sources/DbExtra-sqlite.php
  9. +40 −23 Sources/DbPackages-mysql.php
  10. +34 −23 Sources/DbPackages-postgresql.php
  11. +36 −23 Sources/DbPackages-sqlite.php
  12. +1 −1 Sources/DbSearch-postgresql.php
  13. +1 −1 Sources/DbSearch-sqlite.php
  14. +10 −6 Sources/Display.php
  15. +4 −3 Sources/Drafts.php
  16. +4 −2 Sources/Errors.php
  17. +3 −1 Sources/Karma.php
  18. +2 −2 Sources/Load.php
  19. +1 −1 Sources/LogInOut.php
  20. +3 −2 Sources/Logging.php
  21. +5 −3 Sources/ManageAttachments.php
  22. +8 −3 Sources/ManageBans.php
  23. +4 −3 Sources/ManageBoards.php
  24. +7 −1 Sources/ManageLanguages.php
  25. +3 −1 Sources/ManageMaintenance.php
  26. +5 −0 Sources/ManageNews.php
  27. +1 −1 Sources/ManagePermissions.php
  28. +4 −0 Sources/ManageSearch.php
  29. +7 −0 Sources/ManageSearchEngines.php
  30. +40 −0 Sources/ManageSettings.php
  31. +14 −1 Sources/MoveTopic.php
  32. +18 −3 Sources/News.php
  33. +43 −0 Sources/Packages.php
  34. +2 −2 Sources/PersonalMessage.php
  35. +2 −0 Sources/Post.php
  36. +2 −5 Sources/PostModeration.php
  37. +3 −3 Sources/Profile-Actions.php
  38. +3 −3 Sources/Profile-Modify.php
  39. +17 −0 Sources/Profile-View.php
  40. +8 −4 Sources/QueryString.php
  41. +6 −2 Sources/RemoveTopic.php
  42. +3 −1 Sources/RepairBoards.php
  43. +1 −1 Sources/Reports.php
  44. +14 −1 Sources/ScheduledTasks.php
  45. +77 −11 Sources/SearchAPI-Custom.php
  46. +37 −9 Sources/SearchAPI-Fulltext.php
  47. +24 −4 Sources/SearchAPI-Standard.php
  48. +7 −7 Sources/Security.php
  49. +5 −5 Sources/Session.php
  50. +6 −0 Sources/Subs-Admin.php
  51. +8 −6 Sources/Subs-Auth.php
  52. +1 −1 Sources/Subs-Boards.php
  53. +23 −23 Sources/Subs-Calendar.php
  54. +3 −4 Sources/Subs-Categories.php
  55. +16 −14 Sources/Subs-Db-mysql.php
  56. +28 −4 Sources/Subs-Db-postgresql.php
  57. +21 −1 Sources/Subs-Db-sqlite.php
  58. +5 −0 Sources/Subs-Editor.php
  59. +7 −6 Sources/Subs-Graphics.php
  60. +22 −5 Sources/Subs-Membergroups.php
  61. +11 −6 Sources/Subs-Members.php
  62. +2 −2 Sources/Subs-Menu.php
  63. +7 −0 Sources/Subs-MessageIndex.php
  64. +2 −2 Sources/Subs-OpenID.php
  65. +69 −13 Sources/Subs-Package.php
  66. +15 −10 Sources/Subs-Post.php
  67. +1 −1 Sources/Subs-Sound.php
  68. +10 −7 Sources/Subs.php
  69. +12 −2 Sources/Themes.php
  70. +3 −5 Sources/Who.php
  71. +3 −1 attachments/index.php
  72. +3 −1 avatars/index.php
View
@@ -1,6 +1,8 @@
<?php
-// This file is here solely to protect your Packages directory.
+/**
+ * This file is here solely to protect your Packages directory.
+ */
// Look for Settings.php....
if (file_exists(dirname(dirname(__FILE__)) . '/Settings.php'))
View
@@ -1,6 +1,8 @@
<?php
-// This file is here solely to protect your Smileys directory.
+/**
+ * This file is here solely to protect your Smileys directory.
+ */
// Look for Settings.php....
if (file_exists(dirname(dirname(__FILE__)) . '/Settings.php'))
@@ -1,8 +1,21 @@
<?php
/**
- * This class is an experiment for the job of correctly detecting browsers and settings
- * needed for them.
+ * Simple Machines Forum (SMF)
+ *
+ * @package SMF
+ * @author Simple Machines http://www.simplemachines.org
+ * @copyright 2012 Simple Machines
+ * @license http://www.simplemachines.org/about/smf/license.php BSD
+ *
+ * @version 2.1 Alpha 1
+ */
+
+if (!defined('SMF'))
+ die('Hacking attempt...');
+
+/**
+ * This class is an experiment for the job of correctly detecting browsers and settings needed for them.
* - Detects the following browsers
* - Opera, Webkit, Firefox, Web_tv, Konqueror, IE, Gecko
* - Webkit variants: Chrome, iphone, blackberry, android, safari, ipad, ipod
@@ -12,10 +25,6 @@
* - IE Versions: 4, 5, 5.5, 6, 7, 8, 9, 10 ... mobile and Mac
* - Nokia
*/
-
-if (!defined('SMF'))
- die('Hacking attempt...');
-
class browser_detector
{
/**
@@ -24,6 +33,12 @@ class browser_detector
* @var array
*/
private $_browsers = null;
+
+ /**
+ * Holds if the detected device may be a mobile one
+ *
+ * @var type
+ */
private $_is_mobile = null;
/**
@@ -1,7 +1,19 @@
<?php
/**
- *
* Simple Machines Forum (SMF)
+ *
+ * @package SMF
+ * @author Simple Machines http://www.simplemachines.org
+ * @copyright 2012 Simple Machines
+ * @license http://www.simplemachines.org/about/smf/license.php BSD
+ *
+ * @version 2.1 Alpha 1
+ */
+
+if (!defined('SMF'))
+ die('Hacking attempt...');
+
+/**
* Simple cURL class to fetch a web page
* Properly redirects even with safe mode and basedir restrictions
* Can provide simple post options to a page
@@ -23,20 +35,14 @@
* - $fetch_data->result(); // an array of results, body, header, http result codes
* - $fetch_data->result_raw(); // show all results of all calls (in the event of a redirect)
* - $fetch_data->result_raw(0); // show all results of call x
- *
- * @package SMF
- * @author Simple Machines http://www.simplemachines.org
- * @copyright 2012 Simple Machines
- * @license http://www.simplemachines.org/about/smf/license.php BSD
- *
- * @version 2.1 Alpha 1
*/
-
-if (!defined('SMF'))
- die('Hacking attempt...');
-
class curl_fetch_web_data
{
+ /**
+ * Set the default itmes for this class
@joshuaadickerson

joshuaadickerson Dec 31, 2012

Contributor

Just a note - items is misspelled.

+ *
+ * @var type
+ */
private $default_options = array(
CURLOPT_RETURNTRANSFER => 1, // Get returned value as a string (don't output it)
CURLOPT_HEADER => 1, // We need the headers to do our own redirect
@@ -55,8 +61,8 @@ class curl_fetch_web_data
* Start the curl object
* - allow for user override values
*
- * @param type $options, cURL options as an array
- * @param type $max_redirect, use to overide the default of 3
+ * @param type $options cURL options as an array
+ * @param type $max_redirect use to overide the default of 3
*/
public function __construct($options = array(), $max_redirect = 3)
{
@@ -72,8 +78,8 @@ public function __construct($options = array(), $max_redirect = 3)
* - passed arrays will be converted to a post string joined with &'s
* - calls set_options to set the curl opts array values based on the defaults and user input
*
- * @param type $url, the site we are going to fetch
- * @param type $post_data, any post data as form name => value
+ * @param type $url the site we are going to fetch
+ * @param type $post_data any post data as form name => value
*/
public function get_url_data($url, $post_data = array())
{
@@ -95,8 +101,8 @@ public function get_url_data($url, $post_data = array())
* - stores responses (url, code, error, headers, body) in the response array
* - detects 301, 302, 307 codes and will redirect to the given response header location
*
- * @param type $url, site to fetch
- * @param type $redirect, flag to indicate if this was a redirect request or not
+ * @param type $url site to fetch
+ * @param type $redirect flag to indicate if this was a redirect request or not
* @return boolean
*/
private function curl_request($url, $redirect = false)
@@ -151,8 +157,8 @@ private function curl_request($url, $redirect = false)
/**
* Used if being redirected to ensure we have a fully qualified address
*
- * @param type $last_url, where we went to
- * @param type $new_url, where we were redirected to
+ * @param type $last_url where we went to
+ * @param type $new_url where we were redirected to
* @return new url location
*/
private function get_redirect_url($last_url = '', $new_url = '')
@@ -176,7 +182,7 @@ private function get_redirect_url($last_url = '', $new_url = '')
* - called as ->result() will return the full final array
* - called as ->result('body') to just return the page source of the result
*
- * @param type $area, used to return an area such as body, header, error
+ * @param type $area used to return an area such as body, header, error
* @return type
*/
public function result($area = '')
Oops, something went wrong.

0 comments on commit c8e62fe

Please sign in to comment.