litefeel / writing-on-github

lib/client/base.php

Doc Comments +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
 	 * @param string $endpoint API endpoint.
 	 * @param array  $body Request body.
 	 *
-	 * @return stdClass|WP_Error
+	 * @return stdClass
 	 */
 	protected function call( $method, $endpoint, $body = array() ) {
 		if ( is_wp_error( $error = $this->can_call() ) ) {

lib/client/persist.php

Doc Comments +1 added lines

@@ -31,6 +31,7 @@
 	/**
 	 * Delete the file.
 	 *
+	 * @param string $message
 	 * @return array
 	 */
 	public function delete_file( $path, $sha, $message ) {

lib/controller.php

Doc Comments +2 added lines, -2 removed lines

@@ -167,7 +167,7 @@ 
 	 *
 	 * @param int $post_id Post ID.
 	 *
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	public function export_post( $post_id ) {
 		if ( wp_is_post_revision( $post_id ) ) {
@@ -199,7 +199,7 @@ 
 	 *
 	 * @param int $post_id Post ID.
 	 *
-	 * @return boolean
+	 * @return null|boolean
 	 */
 	public function delete_post( $post_id ) {
 		if ( wp_is_post_revision( $post_id ) ) {

lib/database.php

Doc Comments +3 added lines, -1 removed lines

@@ -108,7 +108,6 @@ 
 	 * and associates their author as well as their latest
 	 *
 	 * @param Writing_On_GitHub_Post[] $posts Array of Posts to save.
-	 * @param string                       $email Author email.
 	 *
 	 * @return string|WP_Error
 	 */
@@ -178,6 +177,9 @@ 
 		return __( 'Successfully saved posts.', 'writing-on-github' );
 	}
 
+	/**
+	 * @param Writing_On_GitHub_Post $post
+	 */
 	protected function post_args( $post ) {
 		$args = $post->get_args();
 		$meta = $post->get_meta();

lib/export.php

Doc Comments +4 added lines

@@ -142,6 +142,10 @@
 		return true;
 	}
 
+	/**
+	 * @param Writing_On_GitHub_Post $post
+	 * @param Writing_On_GitHub_Persist_Client $persist
+	 */
 	protected function new_post( $post, $persist ) {
 		$github_path = $post->github_path();
 		$old_github_path = $post->old_github_path();

lib/import.php

Doc Comments +3 added lines, -1 removed lines

@@ -140,6 +140,9 @@ 
 		return __( 'Payload processed', 'writing-on-github' );
 	}
 
+	/**
+	 * @param boolean $delete_ids
+	 */
 	protected function compare( $files, &$delete_ids ) {
 		if ( is_wp_error( $files ) ) {
 			return $files;
@@ -217,7 +220,6 @@ 
 	/**
 	 * Checks whether the provided blob should be imported.
 	 *
-	 * @param Writing_On_GitHub_Blob $blob Blob to validate.
 	 *
 	 * @return bool
 	 */

lib/request.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
 	/**
 	 * Validates the header's secret.
 	 *
-	 * @return true|WP_Error
+	 * @return boolean
 	 */
 	public function is_secret_valid() {
 		$headers = $this->headers();