Fix protos

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@291187 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2009-11-23 10:49:33 +00:00
parent b2a848986f
commit 8a08174ef7
20 changed files with 36 additions and 36 deletions

View file

@ -11,9 +11,9 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>SolrUpdateResponse</type><methodname>SolrClient::addDocument</methodname>
<methodparam><type>SolrInputDocument</type><parameter role="reference">doc</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>allowDups</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>commitWithin</parameter></methodparam>
<methodparam><type>SolrInputDocument</type><parameter>doc</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>allowDups</parameter><initializer>false</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>commitWithin</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This method adds a document to the index.
@ -37,7 +37,7 @@
<term><parameter>allowDups</parameter></term>
<listitem>
<para>
If &false; duplicates will be overwritten. Default value is &false;
If &false; duplicates will be overwritten.
</para>
</listitem>
</varlistentry>

View file

@ -11,9 +11,9 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SolrClient::addDocuments</methodname>
<methodparam><type>array</type><parameter role="reference">docs</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>allowDups</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>commitWithin</parameter></methodparam>
<methodparam><type>array</type><parameter>docs</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>allowDups</parameter><initializer>false</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>commitWithin</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Adds a collection of documents to the index.
@ -37,7 +37,7 @@
<term><parameter>allowDups</parameter></term>
<listitem>
<para>
If &false; duplicates will be overwritten. Default value is &false;
If &false; duplicates will be overwritten.
</para>
</listitem>
</varlistentry>

View file

@ -11,9 +11,9 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>SolrUpdateResponse</type><methodname>SolrClient::commit</methodname>
<methodparam choice="opt"><type>int</type><parameter>maxSegments</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>waitFlush</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>waitSearcher</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>maxSegments</parameter><initializer>"1"</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>waitFlush</parameter><initializer>true</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>waitSearcher</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
This method finalizes all add/deletes made to the index.

View file

@ -11,9 +11,9 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>SolrUpdateResponse</type><methodname>SolrClient::optimize</methodname>
<methodparam choice="opt"><type>int</type><parameter>maxSegments</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>waitFlush</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>waitSearcher</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>maxSegments</parameter><initializer>"1"</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>waitFlush</parameter><initializer>true</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>waitSearcher</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
Defragments the index for faster search performance.

View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>SolrQueryResponse</type><methodname>SolrClient::query</methodname>
<methodparam><type>SolrParams</type><parameter role="reference">query</parameter></methodparam>
<methodparam><type>SolrParams</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
Sends a query to the server.

View file

@ -10,9 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SolrDocument::merge</methodname>
<methodparam><type>SolrDocument</type><parameter role="reference">sourceDoc</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>SolrDocument::merge</methodname>
<methodparam><type>SolrDocument</type><parameter>sourceDoc</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
Merges source to the current SolrDocument.

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SolrDocument::__set</methodname>
<modifier>public</modifier> <type>bool</type><methodname>SolrDocument::__set</methodname>
<methodparam><type>string</type><parameter>fieldName</parameter></methodparam>
<methodparam><type>string</type><parameter>fieldValue</parameter></methodparam>
</methodsynopsis>
@ -47,7 +47,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
No return values.
&return.success;
</para>
</refsect1>

View file

@ -10,9 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SolrDocument::sort</methodname>
<modifier>public</modifier> <type>bool</type><methodname>SolrDocument::sort</methodname>
<methodparam><type>int</type><parameter>sortOrderBy</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sortDirection</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sortDirection</parameter><initializer>SolrDocument::SORT_ASC</initializer></methodparam>
</methodsynopsis>
<para>
<![CDATA[

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SolrDocument::__unset</methodname>
<modifier>public</modifier> <type>bool</type><methodname>SolrDocument::__unset</methodname>
<methodparam><type>string</type><parameter>fieldName</parameter></methodparam>
</methodsynopsis>
<para>
@ -40,7 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
&return.success;
</para>
</refsect1>

View file

@ -13,7 +13,7 @@
<modifier>public</modifier> <type>bool</type><methodname>SolrInputDocument::addField</methodname>
<methodparam><type>string</type><parameter>fieldName</parameter></methodparam>
<methodparam><type>string</type><parameter>fieldValue</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>fieldBoostValue</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>fieldBoostValue</parameter><initializer>0.0</initializer></methodparam>
</methodsynopsis>
<para>
For multi-value fields, if a valid boost value is specified, the specified value will be multiplied by the current boost value for this field.

View file

@ -11,8 +11,8 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SolrInputDocument::merge</methodname>
<methodparam><type>SolrInputDocument</type><parameter role="reference">sourceDoc</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam>
<methodparam><type>SolrInputDocument</type><parameter>sourceDoc</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
Merges one input document into another.

View file

@ -12,7 +12,7 @@
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SolrInputDocument::sort</methodname>
<methodparam><type>int</type><parameter>sortOrderBy</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sortDirection</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sortDirection</parameter><initializer>SolrInputDocument::SORT_ASC</initializer></methodparam>
</methodsynopsis>
<para>
<![CDATA[

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SolrInputDocument::toArray</methodname>
<modifier>public</modifier> <type>array</type><methodname>SolrInputDocument::toArray</methodname>
<void />
</methodsynopsis>
<para>

View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>mixed</type><methodname>SolrParams::getParam</methodname>
<methodparam><type>string</type><parameter>param_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>param_name</parameter></methodparam>
</methodsynopsis>
<para>
Returns a parameter with name param_name

View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>string</type><methodname>SolrParams::toString</methodname>
<methodparam choice="opt"><type>bool</type><parameter>url_encode</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>url_encode</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Returns all the name-value pair parameters in the object

View file

@ -12,7 +12,7 @@
<methodsynopsis>
<modifier>public</modifier><type>SolrQuery</type><methodname>SolrQuery::addSortField</methodname>
<methodparam><type>string</type><parameter>field</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>order</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>order</parameter><initializer>SolrQuery::ORDER_DESC</initializer></methodparam>
</methodsynopsis>
<para>
Used to control how the results should be sorted.

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SolrQuery::getFacetDateOther</methodname>
<modifier>public</modifier> <type>array</type><methodname>SolrQuery::getFacetDateOther</methodname>
<methodparam choice="opt"><type>string</type><parameter>field_override</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier><type>SolrQuery</type><methodname>SolrQuery::setFacetDateHardEnd</methodname>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam><type>bool</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>field_override</parameter></methodparam>
</methodsynopsis>
<para>

View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SolrResponse::setParseMode</methodname>
<methodparam choice="opt"><type>int</type><parameter>parser_mode</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>parser_mode</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Sets the parse mode.

View file

@ -12,7 +12,7 @@
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>SolrObject</type><methodname>SolrUtils::digestXmlResponse</methodname>
<methodparam><type>string</type><parameter>xmlresponse</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>parse_mode</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>parse_mode</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
This method parses an response XML string from the Apache Solr server into a SolrObject. It throws a SolrException if there was an error.