sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Removed documentation for private properties, as discussed on the list: http://markmail.org/message/go3tvlob2kds63cv

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@298830 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2010-05-01 04:42:27 +00:00
parent 2ffac64cfa
commit 79930e5bd3
9 changed files with 0 additions and 318 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
language/predefined/exception.xml
View file

@ -42,11 +42,6 @@
<type>string</type>
<varname linkend="exception.props.message">message</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>string</type>
<varname linkend="exception.props.string">string</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>protected</modifier>
<type>int</type>
@ -62,11 +57,6 @@
<type>int</type>
<varname linkend="exception.props.line">line</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<type>array</type>
<varname linkend="exception.props.trace">trace</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
@ -87,12 +77,6 @@
<para>The exception message</para>
</listitem>
</varlistentry>
<varlistentry xml:id="exception.props.string">
<term><varname>string</varname></term>
<listitem>
<para>Internal Exception name</para>
</listitem>
</varlistentry>
<varlistentry xml:id="exception.props.code">
<term><varname>code</varname></term>
<listitem>
@ -111,12 +95,6 @@
<para>The line where the exception was thrown</para>
</listitem>
</varlistentry>
<varlistentry xml:id="exception.props.trace">
<term><varname>trace</varname></term>
<listitem>
<para>The stack trace</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->

125
reference/rar/rarentry.xml
View file

@ -279,53 +279,6 @@
<varname linkend="rarentry.constants.attribute-unix-socket">RarEntry::ATTRIBUTE_UNIX_SOCKET</varname>
<initializer>49152</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.rarfile">rarfile</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.name">name</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.unpacked-size">unpacked_size</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.packed-size">packed_size</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.host-os">host_os</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.file-time">file_time</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.crc">crc</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.attr">attr</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.version">version</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.method">method</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="rarentry.props.flags">flags</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarentry')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
@ -334,84 +287,6 @@
</section>
<!-- {{{ RarEntry properties -->
<section xml:id="rarentry.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="rarentry.props.rarfile">
<term><varname>rarfile</varname></term>
<listitem>
<para>Used internally to hold a reference to the RAR file resource. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.name">
<term><varname>name</varname></term>
<listitem>
<para>Used internally to store the UTF-8 encoded entry name. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.unpacked-size">
<term><varname>unpacked_size</varname></term>
<listitem>
<para>Used internally to store the unpacked entry size. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.packed-size">
<term><varname>packed_size</varname></term>
<listitem>
<para>Used internally to store the packed entry size. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.host-os">
<term><varname>host_os</varname></term>
<listitem>
<para>Used internally to store the host OS. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.file-time">
<term><varname>file_time</varname></term>
<listitem>
<para>Used internally to store the last modification time of the entry. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.crc">
<term><varname>crc</varname></term>
<listitem>
<para>Used internally to store the entry's hexadecimal string representation of its CRC. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.attr">
<term><varname>attr</varname></term>
<listitem>
<para>Used internally to store the entry's attributes. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.version">
<term><varname>version</varname></term>
<listitem>
<para>Used internally to store the minimum RAR version needed to unpack the entry.
It is encoded as 10 * Major version + minor version. This property is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.method">
<term><varname>method</varname></term>
<listitem>
<para>Used internally to store the method used to pack the entry. It is not part of the contract.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarentry.props.flags">
<term><varname>flags</varname></term>
<listitem>
<para>Used internally to store several entry properties, such as dictionary size, whether it's a directory,
is encrypted, is continued in the previous or next volume, is solid or has a comment. Again, not part of the contract.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ RarEntry constants -->
<section xml:id="rarentry.constants">
&reftitle.constants;

48
reference/rar/rarexception.xml
View file

@ -119,14 +119,7 @@
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>private</modifier>
<modifier>static</modifier>
<varname linkend="rarexception.props.usingexceptions">usingExceptions</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.rarexception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
@ -138,47 +131,6 @@
</section>
<!-- {{{ RarException properties -->
<section xml:id="rarexception.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="rarexception.props.message">
<term><varname>message</varname></term>
<listitem>
<para>Not part of the contract. Use <methodname>RarException::getMessage</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarexception.props.code">
<term><varname>code</varname></term>
<listitem>
<para>Not part of the contract. Use <methodname>RarException::getCode</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarexception.props.file">
<term><varname>file</varname></term>
<listitem>
<para>Not part of the contract. Use <methodname>RarException::getFile</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarexception.props.line">
<term><varname>line</varname></term>
<listitem>
<para>Not part of the contract. Use <methodname>RarException::getLine</methodname>.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="rarexception.props.usingexceptions">
<term><varname>usingExceptions</varname></term>
<listitem>
<para>Not part of the contract.
Use <methodname>RarException::isUsingExceptions</methodname> and <methodname>RarException::setUsingExceptions</methodname>.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.rar.entities.rarexception;

23
reference/solr/solrclient.xml
View file

@ -94,13 +94,6 @@
<initializer>terms</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>private</modifier>
<type>integer</type>
<varname linkend="solrclient.props.hashtable-index">_hashtable_index</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrclient')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
@ -108,22 +101,6 @@
</section>
<!-- {{{ SolrClient properties -->
<section xml:id="solrclient.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="solrclient.props.hashtable-index">
<term><varname>_hashtable_index</varname></term>
<listitem>
<para>Used to track each SolrClient instance internally.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ SolrClient constants -->
<section xml:id="solrclient.constants">
&reftitle.constants;

22
reference/solr/solrdocument.xml
View file

@ -85,13 +85,6 @@
<varname linkend="solrdocument.constants.sort-field-boost-value">SolrDocument::SORT_FIELD_BOOST_VALUE</varname>
<initializer>4</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="solrdocument.props.hashtable-index">_hashtable_index</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
@ -101,21 +94,6 @@
</section>
<!-- {{{ SolrDocument properties -->
<section xml:id="solrdocument.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="solrdocument.props.hashtable-index">
<term><modifier>private</modifier><type>integer</type><varname>_hashtable_index</varname></term>
<listitem>
<para>Used internally for mapping object instances in the hash table.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ SolrDocument constants -->
<section xml:id="solrdocument.constants">
&reftitle.constants;

23
reference/solr/solrinputdocument.xml
View file

@ -69,13 +69,6 @@
<varname linkend="solrinputdocument.constants.sort-field-boost-value">SolrInputDocument::SORT_FIELD_BOOST_VALUE</varname>
<initializer>4</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>private</modifier>
<varname linkend="solrinputdocument.props.hashtable-index">_hashtable_index</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrinputdocument')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
@ -83,22 +76,6 @@
<!-- }}} -->
</section>
<!-- {{{ SolrInputDocument properties -->
<section xml:id="solrinputdocument.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="solrinputdocument.props.hashtable-index">
<term><modifier>private</modifier><type>integer</type><varname>_hashtable_index</varname></term>
<listitem>
<para>Used internally to track the document instance.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ SolrInputDocument constants -->
<section xml:id="solrinputdocument.constants">

18
reference/solr/solrmodifiableparams.xml
View file

@ -40,8 +40,6 @@
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.solrmodifiableparams')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
@ -54,22 +52,6 @@
</section>
<!-- {{{ SolrModifiableParams properties -->
<section xml:id="solrmodifiableparams.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="solrmodifiableparams.props.hashtable-index">
<term><varname>_hashtable_index</varname></term>
<listitem>
<para>Used internally to track object instances.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.solr.entities.solrmodifiableparams;

22
reference/solr/solrparams.xml
View file

@ -36,12 +36,6 @@
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>protected</modifier>
<type>integer</type>
<varname linkend="solrparams.props.hashtable-index">_hashtable_index</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
@ -51,22 +45,6 @@
</section>
<!-- {{{ SolrParams properties -->
<section xml:id="solrparams.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="solrparams.props.hashtable-index">
<term><varname>_hashtable_index</varname></term>
<listitem>
<para>Used internally to track object instances.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.solr.entities.solrparams;

15
reference/solr/solrquery.xml
View file

@ -93,21 +93,6 @@
</section>
<!-- {{{ SolrQuery properties -->
<section xml:id="solrquery.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="solrquery.props.hashtable-index">
<term><varname>_hashtable_index</varname></term>
<listitem>
<para>Used internally to track object instances.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ SolrQuery constants -->
<section xml:id="solrquery.constants">
&reftitle.constants;