Automattic / jetpack

_inc/lib/class.media-extractor.php

Doc Comments +1 added lines, -1 removed lines

@@ -74,7 +74,7 @@
 	 * NOTE: If you want IMAGES, call extract( $blog_id, $post_id, ...) which will give you more/better image extraction
 	 * This method will give you an error if you ask for IMAGES.
 	 *
-	 * @param $content The HTML post_content of a post
+	 * @param string $content The HTML post_content of a post
 	 * @param $what_to_extract (int) A mask of things to extract, e.g. Jetpack_Media_Meta_Extractor::IMAGES | Jetpack_Media_Meta_Extractor::MENTIONS
 	 * @param $already_extracted (array) Previously extracted things, e.g. images from extract(), which can be used for x-referencing here
 	 * @returns a structure containing metadata about the embedded things, or empty array if nothing found, or WP_Error on error

json-endpoints/class.wpcom-json-api-site-settings-v1-2-endpoint.php

Doc Comments +3 added lines

@@ -27,6 +27,9 @@
 	}
 
 
+	/**
+	 * @param string $key
+	 */
 	protected function get_locale( $key ) {
 		if ( 'locale' == $key ) {
 			if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {

class.json-api-endpoints.php

Doc Comments +5 added lines

@@ -1341,6 +1341,7 @@ 
 	 * timezone set in the options table for the blog or the GMT offset.
 	 *
 	 * @param datetime string
+	 * @param string $date_string
 	 *
 	 * @return array( $local_time_string, $gmt_time_string )
 	 */
@@ -1458,6 +1459,10 @@ 
 		do_action( 'restapi_theme_init' );
 	}
 
+	/**
+	 * @param string $from_hook
+	 * @param string $to_hook
+	 */
 	function copy_hooks( $from_hook, $to_hook, $base_paths ) {
 		global $wp_filter;
 		foreach ( $wp_filter as $hook => $actions ) {

json-endpoints/class.wpcom-json-api-post-v1-1-endpoint.php

Doc Comments +6 added lines

@@ -120,6 +120,9 @@ 
 		return $response;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	protected function get_sal_post_by( $field, $field_value, $context ) {
 		global $blog_id;
 
@@ -132,6 +135,9 @@ 
 		return $post;
 	}
 
+	/**
+	 * @param string $context
+	 */
 	private function render_response_keys( $post, $context, $keys ) {
 		foreach ( $keys as $key ) {
 			switch ( $key ) {

class.jetpack-data.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
 	/**
 	 * This function mirrors Jetpack_Data::is_usable_domain() in the WPCOM codebase.
 	 *
-	 * @param $domain
+	 * @param string|false $domain
 	 * @param array $extra
 	 *
 	 * @return bool|WP_Error

modules/sso.php

Doc Comments +2 added lines, -2 removed lines

@@ -262,7 +262,7 @@ 
 	 * Validate the require  two step checkbox in Settings > General
 	 *
 	 * @since 2.7
-	 * @return boolean
+	 * @return integer
 	 **/
 	public function validate_jetpack_sso_require_two_step( $input ) {
 		return ( ! empty( $input ) ) ? 1 : 0;
@@ -287,7 +287,7 @@ 
 	 * Validate the match by email check in Settings > General
 	 *
 	 * @since 2.9
-	 * @return boolean
+	 * @return integer
 	 **/
 	public function validate_jetpack_sso_match_by_email( $input ) {
 		return ( ! empty( $input ) ) ? 1 : 0;

json-endpoints/class.wpcom-json-api-list-terms-endpoint.php

Doc Comments +6 added lines

@@ -69,11 +69,17 @@
 		return $args;
 	}
 
+	/**
+	 * @param string $taxonomy
+	 */
 	function get_found( $taxonomy, $args ) {
 		unset( $args['offset'] );
 		return wp_count_terms( $taxonomy, $args );
 	}
 
+	/**
+	 * @param string $taxonomy
+	 */
 	function get_formatted_terms( $taxonomy, $args ) {
 		$terms = get_terms( $taxonomy, $args );
 

modules/videopress/class.videopress-scheduler.php

Doc Comments +1 added lines, -1 removed lines

@@ -85,7 +85,7 @@
 	 *
 	 * @param string $cron_name
 	 *
-	 * @return bool
+	 * @return false|null
 	 */
 	public function activate_cron( $cron_name ) {
 

_inc/lib/icalendar-reader.php

Doc Comments +2 added lines, -4 removed lines

@@ -699,8 +699,7 @@ 
 	 * Render the events
 	 *
 	 * @param string $url (default: '')
-	 * @param string $context (default: 'widget') or 'shortcode'
-	 * @return mixed bool|string false on failure, rendered HTML string on success.
+	 * @return false|string bool|string false on failure, rendered HTML string on success.
 	 */
 	public function render( $url = '', $args = array() ) {
 
@@ -857,8 +856,7 @@ 
  * Wrapper function for iCalendarReader->render()
  *
  * @param string $url (default: '')
- * @param string $context (default: 'widget') or 'shortcode'
- * @return mixed bool|string false on failure, rendered HTML string on success.
+ * @return false|string bool|string false on failure, rendered HTML string on success.
  */
 function icalendar_render_events( $url = '', $args = array() ) {
 	$ical = new iCalendarReader();