Skip to content

Commit

Permalink
Improving phpDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
renatonascalves committed Sep 6, 2023
1 parent dc6a2ea commit 8bf9b44
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
5 changes: 2 additions & 3 deletions includes/classes/Indexable.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@

use ElasticPress\Elasticsearch as Elasticsearch;
use ElasticPress\SyncManager as SyncManager;
use ElasticPress\QueryIntegration as QueryIntegration;

if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
Expand Down Expand Up @@ -49,7 +48,7 @@ abstract class Indexable {
* Instance of QueryIntegration. This should handle integrating with a default
* WP query.
*
* @var QueryIntegration
* @var object
* @since 3.0
*/
public $query_integration;
Expand Down Expand Up @@ -1149,7 +1148,7 @@ abstract public function prepare_document( $object_id );
* process across indexables.
*
* @param array $args Array to query DB against.
* @return boolean
* @return array
*/
abstract public function query_db( $args );

Expand Down
2 changes: 1 addition & 1 deletion includes/classes/Indexables.php
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ public function get_all( $global = null, $slug_only = false, $status = 'active'
/**
* Return singleton instance of class
*
* @return object
* @return self
*/
public static function factory() {
static $instance = false;
Expand Down
11 changes: 6 additions & 5 deletions includes/classes/SyncManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,9 @@ public function __construct( $indexable_slug ) {
/**
* Add an object to the sync queue.
*
* @param id $object_id object ID to sync
* @since 3.1.2
* @since 3.1.2
*
* @param int $object_id Object ID to sync.
* @return boolean
*/
public function add_to_queue( $object_id ) {
Expand All @@ -95,8 +96,9 @@ public function add_to_queue( $object_id ) {
/**
* Remove an object from the sync queue.
*
* @param id $object_id object ID to remove from the queue
* @since 3.5
* @since 3.5
*
* @param int $object_id Object ID to remove from the queue.
* @return boolean
*/
public function remove_from_queue( $object_id ) {
Expand Down Expand Up @@ -147,7 +149,6 @@ public function index_sync_queue_on_redirect( $location ) {
return $location;
}


/**
* Sync objects in queue.
*
Expand Down

0 comments on commit 8bf9b44

Please sign in to comment.