adamjakab / SuiteCRM

include/social/twitter/twitter_auth/twitteroauth/twitteroauth.php

Doc Comments +5 added lines

@@ -55,6 +55,8 @@ 
 
   /**
    * construct TwitterOAuth object
+   * @param string $consumer_key
+   * @param string $consumer_secret
    */
   function __construct($consumer_key, $consumer_secret, $oauth_token = NULL, $oauth_token_secret = NULL) {
     $this->sha1_method = new OAuthSignatureMethod_HMAC_SHA1();
@@ -71,6 +73,7 @@ 
    * Get a request_token from Twitter
    *
    * @returns a key/value array containing oauth_token and oauth_token_secret
+   * @param string $oauth_callback
    */
   function getRequestToken($oauth_callback) {
     $parameters = array();
@@ -170,6 +173,7 @@ 
 
   /**
    * Format and sign an OAuth / API request
+   * @param string $method
    */
   function oAuthRequest($url, $method, $parameters) {
     if (strrpos($url, 'https://') !== 0 && strrpos($url, 'http://') !== 0) {
@@ -188,6 +192,7 @@ 
   /**
    * Make an HTTP request
    *
+   * @param string $postfields
    * @return API results
    */
   function http($url, $method, $postfields = NULL) {

include/social/twitter/twitter_helper.php

Doc Comments +3 added lines

@@ -13,6 +13,9 @@
 }
 
 
+/**
+ * @param integer $limit
+ */
 function format_feed_tweets($db, $array, $limit)
 {
 

include/SubPanel/SubPanel.php

Doc Comments +10 added lines

@@ -102,6 +102,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $template_file
+	 */
 	function setTemplateFile($template_file)
 	{
 		$this->template_file = $template_file;
@@ -271,6 +274,10 @@ 
   }
 
   //saves overrides for defs
+
+  /**
+   * @param string $subsection
+   */
   function saveSubPanelDefOverride( $panel, $subsection, $override){
   		global $layout_defs, $beanList;
 
@@ -406,6 +413,9 @@ 
 		return print_r($where_clauses,true);
 	}
 
+	/**
+	 * @param string $module
+	 */
 	function get_searchdefs($module)
 	{
 		$thisPanel =& $this->subpanel_defs;

include/SubPanel/SubPanelDefinitions.php

Doc Comments +8 added lines

@@ -417,11 +417,19 @@
 	}
 
 	//get value of a property defined at the panel instance level.
+
+	/**
+	 * @param string $name
+	 */
 	function get_inst_prop_value ( $name )
 	{
 		return isset($this->_instance_properties[$name]) ? $this->_instance_properties [ $name ] : null;
 	}
 	//get value of a property defined at the panel definition level.
+
+	/**
+	 * @param string $name
+	 */
 	function get_def_prop_value ( $name )
 	{
 		if (isset ( $this->panel_definition [ $name ] ))

include/SugarCache/SugarCache.php

Doc Comments +2 added lines, -1 removed lines

@@ -167,6 +167,7 @@ 
  *
  * @param String $key -- Global namespace cache.  Key for the data.
  * @param Serializable $value -- The value to store in the cache.
+ * @param integer $ttl
  */
 function sugar_cache_put($key, $value, $ttl = null)
 {
@@ -228,7 +229,7 @@ 
  *
  * @deprecated
  *
- * @return true for success, false for failure.
+ * @return boolean for success, false for failure.
  */
 function sugar_cache_validate()
 {

include/SugarCache/SugarCacheAbstract.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
      *  Set a value for a key in the cache, optionally specify a ttl. A ttl value of zero
      * will indicate that a value should only be stored per the request.
      *
-     * @param $key
+     * @param string $key
      * @param $value
      * @param $ttl
      */
@@ -192,7 +192,7 @@ 
      * PHP's magic __isset() method, used here for checking for a key in the cache.
      *
      * @param  string $key
-     * @return mixed
+     * @return boolean
      */
     public function __isset($key)
     {

include/SugarCharts/Jit/Jit.php

Doc Comments +3 added lines

@@ -68,6 +68,9 @@
 	}
 	
 
+	/**
+	 * @param string $name
+	 */
 	function display($name, $xmlFile, $width='320', $height='480', $resize=false) {
 	
 		parent::display($name, $xmlFile, $width, $height, $resize);

include/SugarCharts/JsChart.php

Doc Comments +6 added lines

@@ -77,6 +77,9 @@ 
 
 	}
 
+	/**
+	 * @param integer $depth
+	 */
 	function tab($str, $depth){
        // $str = preg_replace('/(<\w+>)(.*)(<\/\w+>)/e', "'\\1'.htmlentities(from_html('\\2')).'\\3'", $str);
         return str_repeat("\t", $depth) . $str . "\n";
@@ -663,6 +666,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $jsonContents
+	 */
 	function saveJsonFile($jsonContents) {
 		$this->jsonFilename = str_replace(".xml",".js",$this->xmlFile);
 		//$jsonContents = $GLOBALS['locale']->translateCharset($jsonContents, 'UTF-8', 'UTF-16LE');

include/SugarCharts/SugarChart.php

Doc Comments +7 added lines, -6 removed lines

@@ -292,11 +292,8 @@ 
 	/**
      * returns text with tabs appended before it
 	 *
-     * @param 	string $str xml tag
-     			int $tagFormat 2 = open and close tag, 1 = close, 0 = open
-     			sting $value input string
-	 *			int $depth number of times to tab
      * @return	string with tabs appended before it
+     * @param integer $depth
      */
 
 	function tabValue($tag,$value,$depth) {
@@ -339,6 +336,9 @@ 
 		return $data;
 	}
 
+	/**
+	 * @param integer $tablevel
+	 */
 	function processDataGroup($tablevel, $title, $value, $label, $link){
 		$link = $this->forceHideDataGroupLink ? '' : $link;
 		$data = $this->tab('<group>',$tablevel);
@@ -645,7 +645,7 @@ 
      * This function sets a null group by clause
      *
      * @param $sugarSetValue Mixed value
-     * @param $url String value of URL for the link
+     * @param string $url String value of URL for the link
      */
     private function nullGroup($superSetValue, $url) {
         return $this->processDataGroup(4, $superSetValue, 'NULL', '', $url);
@@ -709,7 +709,8 @@ 
 	 *
      * @param 	string $xmlFilename location of the xml file
 	 *			string $xmlContents contents of the xml file
-     * @return	string boolean denoting whether save has failed
+	 * @param string $xmlContents
+     * @return	null|boolean boolean denoting whether save has failed
      */
 	function saveXMLFile($xmlFilename,$xmlContents) {
 		global $app_strings;