Skip to content

Commit

Permalink
Update documentation and add Apigen config file
Browse files Browse the repository at this point in the history
  • Loading branch information
letrunghieu committed Apr 18, 2014
1 parent 5386930 commit 7853b2f
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 16 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ composer.lock
.DS_Store
/nbproject/private/
nbproject/
docs/
6 changes: 6 additions & 0 deletions apigen.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
source: "./src"
destination: "./docs"
title: "Wordpress XML-RPC PHP Client"
baseUrl: "http://letrunghieu.github.io/wordpress-xmlrpc-client/api"
php: "no"
sourceCode: "no"
32 changes: 16 additions & 16 deletions src/WordpressClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ function getErrorMessage()
*
* @param integer $postId post id The id of selected post
* @param array $fields Optional. List of field or meta-field names to include in response.
* @return array|boolean
* @return array
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPosts
*/
function getPost($postId, array $fields = array())
Expand All @@ -82,7 +82,7 @@ function getPost($postId, array $fields = array())
*
* @param array $filters Optional
* @param array $fields Optional
* @return array|boolean array of struct
* @return array array of struct
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPosts
*/
function getPosts(array $filters = array(), array $fields = array())
Expand All @@ -103,7 +103,7 @@ function getPosts(array $filters = array(), array $fields = array())
* @param array $categorieIds the list of category ids
* @param integer $thumbnailId the thumbnail id
* @param array $content the content array, see more at wordpress documentation
* @return integer|boolean the new post id
* @return integer the new post id
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.newPost
*/
Expand Down Expand Up @@ -159,7 +159,7 @@ function deletePost($postId)
*
* @param string $postTypeName the post type name
* @param array $fields Optional. List of field or meta-field names to include in response.
* @return array|boolean
* @return array
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPostType
*/
Expand All @@ -174,7 +174,7 @@ function getPostType($postTypeName, array $fields = array())
*
* @param array $filter
* @param array $fields
* @return array|boolean list of struct
* @return array list of struct
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPostTypes
*/
Expand All @@ -187,7 +187,7 @@ function getPostTypes(array $filter = array(), array $fields = array())
/**
* Retrieve list of post formats.
*
* @return array|boolean
* @return array
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPostFormats
*/
Expand All @@ -200,7 +200,7 @@ function getPostFormats()
/**
* Retrieve list of supported values for post_status field on posts.
*
* @return array|boolean list of supported post status
* @return array list of supported post status
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Posts#wp.getPostStatusList
*/
Expand All @@ -214,7 +214,7 @@ function getPostStatusList()
* Retrieve information about a taxonomy.
*
* @param string $taxonomy the name of the selected taxonomy
* @return array|boolean taxonomy information
* @return array taxonomy information
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.getTaxonomy
*/
Expand All @@ -227,7 +227,7 @@ function getTaxonomy($taxonomy)
/**
* Retrieve a list of taxonomies.
*
* @return array|boolean array of taxonomy struct
* @return array array of taxonomy struct
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.getTaxonomies
*/
Expand All @@ -242,7 +242,7 @@ function getTaxonomies()
*
* @param integer $termId
* @param string $taxonomy
* @return array|boolean
* @return array
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.getTerm
*/
Expand All @@ -257,7 +257,7 @@ function getTerm($termId, $taxonomy)
*
* @param string $taxonomy
* @param array $filter
* @return array|boolean
* @return array
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.getTerms
*/
Expand All @@ -275,7 +275,7 @@ function getTerms($taxonomy, array $filter = array())
* @param string $slug
* @param string $description
* @param integer $parentId
* @return integer|boolean new term id
* @return integer new term id
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Taxonomies#wp.newTerm
*/
Expand Down Expand Up @@ -337,7 +337,7 @@ function deleteTerm($termId, $taxonomy)
* Retrieve a media item (i.e, attachment).
*
* @param integer $itemId
* @return array|boolean
* @return array
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Media#wp.getMediaItem
*/
Expand All @@ -351,7 +351,7 @@ function getMediaItem($itemId)
* Retrieve list of media items.
*
* @param array $filter
* @return array|boolean
* @return array
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Media#wp.getMediaLibrary
*/
Expand All @@ -367,7 +367,7 @@ function getMediaLibrary(array $filter = array())
* @param string $name
* @param string $mime
* @param string $bits Binary data (no encoded)
* @return array|boolean
* @return array
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Media#wp.uploadFile
*/
Expand All @@ -387,7 +387,7 @@ function uploadFile($name, $mime, $bits)
* Retrieve comment count for a specific post.
*
* @param integer $postId
* @return integer|boolean
* @return integer
*
* @link http://codex.wordpress.org/XML-RPC_WordPress_API/Comments#wp.getCommentCount
*/
Expand Down

0 comments on commit 7853b2f

Please sign in to comment.