Fix types, WS

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@190973 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jakub Vrana 2005-07-19 08:57:53 +00:00
parent ab84daad11
commit 52960cd59b
14 changed files with 60 additions and 65 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-ChangeSummary-getChangeType">
<refnamediv>
@ -11,7 +11,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>integer</type><methodname>SDO_DAS_ChangeSummary::getChangeType</methodname>
<type>int</type><methodname>SDO_DAS_ChangeSummary::getChangeType</methodname>
<methodparam><type>SDO_DataObject</type><parameter>dataObject</parameter></methodparam>
</methodsynopsis>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-ChangeSummary-isLogging">
<refnamediv>
@ -11,14 +11,14 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>boolean</type><methodname>SDO_DAS_ChangeSummary::isLogging</methodname>
<type>bool</type><methodname>SDO_DAS_ChangeSummary::isLogging</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Test to see whether change logging is switched on. Returns true if logging is on, otherwise returns false.
Test to see whether change logging is switched on.
</para>
</refsect1>
@ -31,7 +31,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns true if change logging is on, otherwise returns false.
Returns &true; if change logging is on, otherwise returns &false;.
</para>
</refsect1>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-DataFactory-addPropertyToType">
<refnamediv>
@ -17,9 +17,9 @@
<methodparam><type>string</type><parameter>propertyName</parameter></methodparam>
<methodparam><type>string</type><parameter>propertyNamespaceURI</parameter></methodparam>
<methodparam><type>string</type><parameter>propertyTypeName</parameter></methodparam>
<methodparam choice="opt"><type>boolean</type><parameter>many</parameter></methodparam>
<methodparam choice="opt"><type>boolean</type><parameter>readOnly</parameter></methodparam>
<methodparam choice="opt"><type>boolean</type><parameter>containment</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>many</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>readOnly</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>containment</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
@ -160,7 +160,8 @@ The type of the 'name' property is an SDO data type (primitive) with namespace '
<programlisting role="php">
<![CDATA[
<?php
$df->addPropertyToType('PersonNS', 'PersonType', 'name', 'commonj.sdo', 'String');
$df->addPropertyToType('PersonNS', 'PersonType',
'name', 'commonj.sdo', 'String');
?>
]]>
</programlisting>

View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-DataFactory-addType">
<refnamediv>
<refname>SDO_DAS_DataFactory::addType</refname>
<refpurpose>
Add a new type to a model.
</refpurpose>
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
@ -19,7 +20,7 @@
&warn.experimental.func;
<para>
Add a new type to the SDO_DAS_DataFactory, defined by its namespace and type name.
Add a new type to the SDO_DAS_DataFactory, defined by its namespace and type name.
The type becomes part of the model of data objects that the data factory can create.
</para>
@ -95,7 +96,8 @@ The name of the type.
<example>
<title>A <function>SDO_DAS_DataFactory::addType</function> example</title>
<para>
The following adds a new data object type of 'CompanyType' where that type belongs to the namespace 'CompanyNS'.
The following adds a new data object type of 'CompanyType'
where that type belongs to the namespace 'CompanyNS'.
</para>
<programlisting role="php">
<![CDATA[

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-Setting-getListIndex">
<refnamediv>
@ -11,8 +11,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>integer</type>
<methodname>SDO_DAS_Setting::getListIndex</methodname>
<type>int</type><methodname>SDO_DAS_Setting::getListIndex</methodname>
<void/>
</methodsynopsis>

View file

@ -1,24 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-Setting-isSet">
<refnamediv>
<refname>SDO_DAS_Setting::isSet</refname>
<refpurpose>
Test whether a property was set prior to being modified.
</refpurpose>
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>boolean</type><methodname>SDO_DAS_Setting::isSet</methodname>
<type>bool</type><methodname>SDO_DAS_Setting::isSet</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Test whether a property was set prior to being modified. If it was set prior to being modified then the SDO_DAS_Setting will also contain the old value.
<para>
Test whether a property was set prior to being modified.
If it was set prior to being modified then the SDO_DAS_Setting will also contain the old value.
</para>
</refsect1>
@ -31,8 +33,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns true if the property was set prior to being modified, otherwise returns false.
</para>
Returns &true; if the property was set prior to being modified, otherwise returns &false;.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DataObject-clear">
<refnamediv>
@ -17,9 +17,10 @@
&warn.experimental.func;
<para>
Clear an SDO_DataObject's properties. Read-only properties are unaffected. Subsequent calls to isset() for the data object will return false.
</para>
<para>
Clear an SDO_DataObject's properties. Read-only properties are unaffected.
Subsequent calls to isset() for the data object will return &false;.
</para>
</refsect1>
<refsect1 role="parameters">

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DataObject-createDataObject">
<refnamediv>
@ -18,7 +18,7 @@
&warn.experimental.func;
<para>
Create a child SDO_DataObject of the default type for the property identified.
Create a child SDO_DataObject of the default type for the property identified.
The data object is automatically inserted into the tree and a reference to it is returned.
</para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DataObject-getType">
<refnamediv>
@ -17,10 +17,11 @@
&warn.experimental.func;
<para>
Return an array containing the type information for an SDO_DataObject.
The first element contains the namespace URI string and the second contains the type name string.
</para>
<para>
Return an array containing the type information for an SDO_DataObject.
The first element contains the namespace URI string and the second
contains the type name string.
</para>
</refsect1>
<refsect1 role="parameters">

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-List-insert">
<refnamediv>
@ -15,14 +15,8 @@
<methodsynopsis>
<type>void</type>
<methodname>SDO_List::insert</methodname>
<methodparam>
<type>mixed</type>
<parameter>value</parameter>
</methodparam>
<methodparam choice="opt">
<type>integer</type>
<parameter>index</parameter>
</methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>index</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-Sequence-getPropertyIndex">
<refnamediv>
@ -11,14 +11,15 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>integer</type><methodname>SDO_Sequence::getPropertyIndex</methodname>
<methodparam><type>integer</type><parameter>sequenceIndex</parameter></methodparam>
<type>int</type><methodname>SDO_Sequence::getPropertyIndex</methodname>
<methodparam><type>int</type><parameter>sequenceIndex</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Return the property index for the specified sequence index.
Return the property index for the specified sequence index.
If the sequence item is unstructured text rather than a data object property, then a value of -1 is returned.
</para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-Sequence-getPropertyName">
<refnamediv>
@ -12,13 +12,14 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_Sequence::getPropertyName</methodname>
<methodparam><type>integer</type><parameter>sequenceIndex</parameter></methodparam>
<methodparam><type>int</type><parameter>sequenceIndex</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Return the property name for the specified sequence index.
Return the property name for the specified sequence index.
If the sequence item is unstructured text rather than a data object property, then a value of NULL is returned.
</para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-Sequence-insert">
<refnamediv>
@ -13,7 +13,7 @@
<methodsynopsis>
<type>void</type><methodname>SDO_Sequence::insert</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>sequenceIndex</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>sequenceIndex</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>propertyIdentifier</parameter></methodparam>
</methodsynopsis>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-Sequence-move">
<refnamediv>
@ -11,16 +11,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>SDO_Sequence::move</methodname>
<methodparam>
<type>integer</type>
<parameter>toIndex</parameter>
</methodparam>
<methodparam>
<type>integer</type>
<parameter>fromIndex</parameter>
</methodparam>
<type>void</type><methodname>SDO_Sequence::move</methodname>
<methodparam><type>int</type><parameter>toIndex</parameter></methodparam>
<methodparam><type>int</type><parameter>fromIndex</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;