DOCS Fix doc block formatting in SolrService

This commit is contained in:
Robbie Averill 2019-05-17 09:53:16 +12:00
parent b1ec2ed6d9
commit 14b35f1935
1 changed files with 16 additions and 7 deletions

View File

@ -16,6 +16,11 @@ class SolrService extends SolrService_Core
/**
* Handle encoding the GET parameters and making the HTTP call to execute a core command
*
* @param string $command
* @param string $core
* @param array $params
* @return Apache_Solr_Response
*/
protected function coreCommand($command, $core, $params = array())
{
@ -28,6 +33,7 @@ class SolrService extends SolrService_Core
/**
* Is the passed core active?
*
* @param string $core The name of the core (an encoded class name)
* @return boolean True if that core exists & is active
*/
@ -40,11 +46,12 @@ class SolrService extends SolrService_Core
/**
* Create a new core
* @param $core string - The name of the core
* @param $instancedir string - The base path of the core on the server
* @param $config string - The filename of solrconfig.xml on the server. Default is $instancedir/solrconfig.xml
* @param $schema string - The filename of schema.xml on the server. Default is $instancedir/schema.xml
* @param $datadir string - The path to store data for this core on the server. Default depends on solrconfig.xml
*
* @param string $core The name of the core
* @param string $instancedir The base path of the core on the server
* @param string $config The filename of solrconfig.xml on the server. Default is $instancedir/solrconfig.xml
* @param string $schema The filename of schema.xml on the server. Default is $instancedir/schema.xml
* @param string $datadir The path to store data for this core on the server. Default depends on solrconfig.xml
* @return Apache_Solr_Response
*/
public function coreCreate($core, $instancedir, $config = null, $schema = null, $datadir = null)
@ -65,7 +72,8 @@ class SolrService extends SolrService_Core
/**
* Reload a core
* @param $core string - The name of the core
*
* @param string $core The name of the core
* @return Apache_Solr_Response
*/
public function coreReload($core)
@ -75,7 +83,8 @@ class SolrService extends SolrService_Core
/**
* Create a new Solr4Service_Core instance for the passed core
* @param $core string - The name of the core
*
* @param string $core The name of the core
* @return Solr4Service_Core
*/
public function serviceForCore($core)