Automattic / jetpack

class.jetpack-autoupdate.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 	/**
 	 * Iterates through expected items ( plugins or themes ) and compares them to actual results.
 	 *
-	 * @param $items 'plugin' or 'theme'
+	 * @param string $items 'plugin' or 'theme'
 	 */
 	private function log_items( $items ) {
 		if ( ! isset( $this->expected[ $items ] ) ) {

modules/custom-post-types/portfolios.php

Doc Comments +5 added lines, -4 removed lines

@@ -488,7 +488,7 @@ 
 	 * Our [portfolio] shortcode.
 	 * Prints Portfolio data styled to look good on *any* theme.
 	 *
-	 * @return portfolio_shortcode_html
+	 * @return string
 	 */
 	static function portfolio_shortcode( $atts ) {
 		// Default attributes
@@ -621,7 +621,7 @@ 
 	 * The Portfolio shortcode loop.
 	 *
 	 * @todo add theme color styles
-	 * @return html
+	 * @return string
 	 */
 	static function portfolio_shortcode_html( $atts ) {
 
@@ -713,6 +713,7 @@ 
 	/**
 	 * Individual project class
 	 *
+	 * @param integer $portfolio_index_number
 	 * @return string
 	 */
 	static function get_project_class( $portfolio_index_number, $columns ) {
@@ -820,7 +821,7 @@ 
 	/**
 	 * Displays the author of the current portfolio project.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function get_project_author() {
 		$html = '<div class="project-author">';
@@ -837,7 +838,7 @@ 
 	/**
 	 * Display the featured image if it's available
 	 *
-	 * @return html
+	 * @return string|null
 	 */
 	static function get_portfolio_thumbnail_link( $post_id ) {
 		if ( has_post_thumbnail( $post_id ) ) {

modules/custom-post-types/testimonial.php

Doc Comments +4 added lines, -3 removed lines

@@ -525,7 +525,7 @@ 
 	 * Our [testimonial] shortcode.
 	 * Prints Testimonial data styled to look good on *any* theme.
 	 *
-	 * @return jetpack_testimonial_shortcode_html
+	 * @return string
 	 */
 	static function jetpack_testimonial_shortcode( $atts ) {
 		// Default attributes
@@ -588,7 +588,7 @@ 
 	/**
 	 * The Testimonial shortcode loop.
 	 *
-	 * @return html
+	 * @return string
 	 */
 	static function jetpack_testimonial_shortcode_html( $atts ) {
 		// Default query arguments
@@ -662,6 +662,7 @@ 
 	/**
 	 * Individual testimonial class
 	 *
+	 * @param integer $testimonial_index_number
 	 * @return string
 	 */
 	static function get_testimonial_class( $testimonial_index_number, $columns, $image ) {
@@ -708,7 +709,7 @@ 
 	/**
 	 * Display the featured image if it's available
 	 *
-	 * @return html
+	 * @return string|null
 	 */
 	static function get_testimonial_thumbnail_link( $post_id ) {
 		if ( has_post_thumbnail( $post_id ) ) {

modules/protect/transient-cleanup.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
 	 *
 	 * @access public
 	 * @param string $older_than (default: '1 hour') Older Than.
-	 * @return void
+	 * @return false|null
 	 */
 	function jp_purge_transients( $older_than = '1 hour' ) {
 		global $wpdb;

modules/sso/class.jetpack-sso-helpers.php

Doc Comments +1 added lines, -1 removed lines

@@ -179,7 +179,7 @@
 	 * @param array $hosts
 	 * @param string $api_base
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	static function allowed_redirect_hosts( $hosts, $api_base = JETPACK__API_BASE ) {
 		if ( empty( $hosts ) ) {

modules/related-posts/jetpack-related-posts.php

Doc Comments +5 added lines

@@ -294,6 +294,9 @@ 
 		return $this->_options;
 	}
 	
+	/**
+	 * @param string $option_name
+	 */
 	public function get_option( $option_name ) {
 		$options = $this->get_options();
 		
@@ -1428,6 +1431,8 @@ 
 	 * Enqueues assets needed to do async loading of related posts.
 	 *
 	 * @uses wp_enqueue_script, wp_enqueue_style, plugins_url
+	 * @param boolean $script
+	 * @param boolean $style
 	 * @return null
 	 */
 	protected function _enqueue_assets( $script, $style ) {

json-endpoints/jetpack/class.jetpack-json-api-plugins-endpoint.php

Doc Comments +3 added lines

@@ -170,6 +170,9 @@
 	}
 
 
+	/**
+	 * @param string $plugin
+	 */
 	protected function validate_plugin( $plugin ) {
 		if ( ! isset( $plugin) || empty( $plugin ) ) {
 			return new WP_Error( 'missing_plugin', __( 'You are required to specify a plugin to activate.', 'jetpack' ), 400 );

modules/widgets/internet-defense-league.php

Doc Comments +3 added lines

@@ -129,6 +129,9 @@
 		echo '<p>' . sprintf( _x( 'Learn more about the %s', 'the Internet Defense League', 'jetpack' ), '<a href="https://www.internetdefenseleague.org/">Internet Defense League</a>' ) . '</p>';
 	}
 
+	/**
+	 * @param string $field_name
+	 */
 	public function select( $field_name, $options, $default = null ) {
 		echo '<select class="widefat" name="' . $this->get_field_name( $field_name ) . '">';
 		foreach ( $options as $option_slug => $option_name ) {

sal/class.json-api-site-jetpack-base.php

Doc Comments +13 added lines

@@ -4,10 +4,20 @@ 
 require_once dirname( __FILE__ ) . '/class.json-api-site-base.php';
 
 abstract class Abstract_Jetpack_Site extends SAL_Site {
+
+	/**
+	 * @param string $name
+	 */
 	abstract protected function get_constant( $name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function current_theme_supports( $feature_name );
 
+	/**
+	 * @param string $feature_name
+	 */
 	abstract protected function get_theme_support( $feature_name );
 
 	abstract protected function get_mock_option( $name );
@@ -16,6 +26,9 @@ 
 
 	abstract public function get_updates();
 
+	/**
+	 * @return string
+	 */
 	abstract protected function main_network_site();
 
 	abstract protected function wp_version();