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();

Spyc.php

Doc Comments +77 added lines, -1 removed lines

@@ -361,7 +361,7 @@ 
      * Creates a literal block for dumping
      * @access private
      * @return string
-     * @param $value
+     * @param string $value
      * @param $indent int The value of the indent
      */
   private function _doLiteralBlock($value,$indent) {
@@ -430,6 +430,9 @@ 
     return in_array($value, $words, true);
   }
 
+  /**
+   * @param string $value
+   */
   private function isTranslationWord($value) {
     return (
       self::isTrueWord($value)  ||
@@ -471,11 +474,17 @@ 
 
 // LOADING FUNCTIONS
 
+  /**
+   * @param string $input
+   */
   private function __load($input) {
     $Source = $this->loadFromSource($input);
     return $this->loadWithSource($Source);
   }
 
+  /**
+   * @param string $input
+   */
   private function __loadString($input) {
     $Source = $this->loadFromString($input);
     return $this->loadWithSource($Source);
@@ -692,6 +701,7 @@ 
   /**
      * Used in inlines to check for more inlines or quoted strings
      * @access private
+     * @param string $inline
      * @return array
      */
   private function _inlineEscape($inline) {
@@ -822,12 +832,18 @@ 
     return $explode;
   }
 
+  /**
+   * @param integer $lineIndent
+   */
   private function literalBlockContinues ($line, $lineIndent) {
     if (!trim($line)) return true;
     if (strlen($line) - strlen(ltrim($line)) > $lineIndent) return true;
     return false;
   }
 
+  /**
+   * @param boolean $alias
+   */
   private function referenceContentsByAlias ($alias) {
     do {
       if (!isset($this->SavedGroups[$alias])) { echo "Bad group name: $alias."; break; }
@@ -926,6 +942,9 @@ 
 
   }
 
+  /**
+   * @param string $line
+   */
   private static function startsLiteralBlock ($line) {
     $lastChar = substr (trim($line), -1);
     if ($lastChar != '>' && $lastChar != '|') return false;
@@ -935,6 +954,9 @@ 
     return $lastChar;
   }
 
+  /**
+   * @param string $line
+   */
   private static function greedilyNeedNextLine($line) {
     $line = trim ($line);
     if (!strlen($line)) return false;
@@ -944,6 +966,10 @@ 
     return false;
   }
 
+  /**
+   * @param string $literalBlock
+   * @param string $literalBlockStyle
+   */
   private function addLiteralLine ($literalBlock, $line, $literalBlockStyle, $indent = -1) {
     $line = self::stripIndent($line, $indent);
     if ($literalBlockStyle !== '|') {
@@ -963,6 +989,9 @@ 
     return $literalBlock . $line;
   }
 
+   /**
+    * @param string $literalBlock
+    */
    function revertLiteralPlaceHolder ($lineArray, $literalBlock) {
      foreach ($lineArray as $k => $_) {
       if (is_array($_))
@@ -978,6 +1007,9 @@ 
     return substr ($line, $indent);
   }
 
+  /**
+   * @param integer $indent
+   */
   private function getParentPathByIndent ($indent) {
     if ($indent == 0) return array();
     $linePath = $this->path;
@@ -1003,6 +1035,9 @@ 
   }
 
 
+  /**
+   * @param string $line
+   */
   private static function isComment ($line) {
     if (!$line) return false;
     if ($line[0] == '#') return true;
@@ -1010,6 +1045,9 @@ 
     return false;
   }
 
+  /**
+   * @param string $line
+   */
   private static function isEmpty ($line) {
     return (trim ($line) === '');
   }
@@ -1035,6 +1073,9 @@ 
   }
 
 
+  /**
+   * @param string $value
+   */
   private static function unquote ($value) {
     if (!$value) return $value;
     if (!is_string($value)) return $value;
@@ -1043,10 +1084,16 @@ 
     return $value;
   }
 
+  /**
+   * @param string $line
+   */
   private function startsMappedSequence ($line) {
     return (substr($line, 0, 2) == '- ' && substr ($line, -1, 1) == ':');
   }
 
+  /**
+   * @param string $line
+   */
   private function returnMappedSequence ($line) {
     $array = array();
     $key         = self::unquote(trim(substr($line,1,-1)));
@@ -1063,6 +1110,9 @@ 
     }
   }
 
+  /**
+   * @param string $line
+   */
   private function returnMappedValue ($line) {
     $this->checkKeysInValue($line);
     $array = array();
@@ -1071,18 +1121,30 @@ 
     return $array;
   }
 
+  /**
+   * @param string $line
+   */
   private function startsMappedValue ($line) {
     return (substr ($line, -1, 1) == ':');
   }
 
+  /**
+   * @param string $line
+   */
   private function isPlainArray ($line) {
     return ($line[0] == '[' && substr ($line, -1, 1) == ']');
   }
 
+  /**
+   * @param string $line
+   */
   private function returnPlainArray ($line) {
     return $this->_toType($line);
   }
 
+  /**
+   * @param string $line
+   */
   private function returnKeyValuePair ($line) {
     $array = array();
     $key = '';
@@ -1111,6 +1173,9 @@ 
   }
 
 
+  /**
+   * @param string $line
+   */
   private function returnArrayElement ($line) {
      if (strlen($line) <= 1) return array(array()); // Weird %)
      $array = array();
@@ -1124,6 +1189,9 @@ 
   }
 
 
+  /**
+   * @param string $line
+   */
   private function nodeContainsGroup ($line) {
     $symbolsForReference = 'A-z0-9_\-';
     if (strpos($line, '&') === false && strpos($line, '*') === false) return false; // Please die fast ;-)
@@ -1136,12 +1204,20 @@ 
 
   }
 
+  /**
+   * @param string $line
+   * @param string $group
+   */
   private function addGroup ($line, $group) {
     if ($group[0] == '&') $this->_containsGroupAnchor = substr ($group, 1);
     if ($group[0] == '*') $this->_containsGroupAlias = substr ($group, 1);
     //print_r ($this->path);
   }
 
+  /**
+   * @param string $line
+   * @param string $group
+   */
   private function stripGroup ($line, $group) {
     $line = trim(str_replace($group, '', $line));
     return $line;

tests/unit/client/test-fetch.php

Doc Comments +3 added lines

@@ -159,6 +159,9 @@
 	// 	}
 	// }
 
+	/**
+	 * @param string $repo
+	 */
 	protected function malformed_repo( $repo ) {
 		update_option( Base::REPO_OPTION_KEY, $repo );