updated trader docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@327082 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Anatol Belski 2012-08-12 19:17:11 +00:00
parent 81de01788d
commit 33f18c7523
4 changed files with 259 additions and 3 deletions

View file

@ -386,6 +386,196 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-success">
<term>
<constant>TRADER_ERR_SUCCESS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-lib-not-initialize">
<term>
<constant>TRADER_ERR_LIB_NOT_INITIALIZE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-bad-param">
<term>
<constant>TRADER_ERR_BAD_PARAM</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-alloc-err">
<term>
<constant>TRADER_ERR_ALLOC_ERR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-group-not-found">
<term>
<constant>TRADER_ERR_GROUP_NOT_FOUND</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-func-not-found">
<term>
<constant>TRADER_ERR_FUNC_NOT_FOUND</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-invalid-handle">
<term>
<constant>TRADER_ERR_INVALID_HANDLE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-invalid-param-holder">
<term>
<constant>TRADER_ERR_INVALID_PARAM_HOLDER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-invalid-param-holder-type">
<term>
<constant>TRADER_ERR_INVALID_PARAM_HOLDER_TYPE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-invalid-param-function">
<term>
<constant>TRADER_ERR_INVALID_PARAM_FUNCTION</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-input-not-all-initialize">
<term>
<constant>TRADER_ERR_INPUT_NOT_ALL_INITIALIZE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-output-not-all-initialize">
<term>
<constant>TRADER_ERR_OUTPUT_NOT_ALL_INITIALIZE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-out-of-range-start-index">
<term>
<constant>TRADER_ERR_OUT_OF_RANGE_START_INDEX</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-out-of-range-end-index">
<term>
<constant>TRADER_ERR_OUT_OF_RANGE_END_INDEX</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-invalid-list-type">
<term>
<constant>TRADER_ERR_INVALID_LIST_TYPE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-bad-object">
<term>
<constant>TRADER_ERR_BAD_OBJECT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-not-supported">
<term>
<constant>TRADER_ERR_NOT_SUPPORTED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-internal-error">
<term>
<constant>TRADER_ERR_INTERNAL_ERROR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.trader-err-unknown-error">
<term>
<constant>TRADER_ERR_UNKNOWN_ERROR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</appendix>

View file

@ -0,0 +1,47 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 325956 $ -->
<refentry xml:id="function.trader-errno" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>trader_errno</refname>
<refpurpose>Get error code</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>integer</type><methodname>trader_errno</methodname>
<void/>
</methodsynopsis>
<para>
Get error code of the last operation.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>Returns the error code.</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -21,7 +21,13 @@
<entry><link linkend="ini.trader.real-precision">trader.real_precision</link></entry>
<entry>3</entry>
<entry>PHP_INI_ALL</entry>
<entry><!-- leave empty, this will be filled by an automatic script --></entry>
<entry>Since trader 0.2.1</entry>
</row>
<row>
<entry><link linkend="ini.trader.real-round-mode">trader.real_precision</link></entry>
<entry>HALF_DOWN</entry>
<entry>PHP_INI_ALL</entry>
<entry>Since trader 0.3.0</entry>
</row>
</tbody>
</tgroup>
@ -39,11 +45,23 @@
</term>
<listitem>
<para>
All the values in the returned arrays will be rounded to this precision.
However the calculations inside TA-Lib happen with unrounded values.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.trader.real-round-mode">
<term>
<parameter>trader.real_round_mode</parameter>
<type>string</type>
</term>
<listitem>
<para>
Controls the trader real rounding policy. Valid values are <literal>HALF_UP</literal>,
<literal>HALF_DOWN</literal>, <literal>HALF_EVEN</literal> and <literal>HALF_ODD</literal>. The behaviour is identical to the <link linkend="function.round">round()</link> function used with the mode argument.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>

View file

@ -168,6 +168,7 @@
<function name='trader_get_unstable_period' from='PECL trader &gt;= 0.2.2'/>
<function name='trader_set_compat' from='PECL trader &gt;= 0.2.2'/>
<function name='trader_get_compat' from='PECL trader &gt;= 0.2.2'/>
<function name='trader_errno' from='PECL trader &gt;= 0.3.0'/>
</versions>
<!-- Keep this comment at the end of the file