remove dot for refpurpose + correct method output

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@203168 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jean-Sébastien Goupil 2005-12-18 16:44:49 +00:00
parent 8f213e0407
commit 00c18f561c
21 changed files with 98 additions and 177 deletions

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getEncoding">
<refnamediv>
<refname>SDO_DAS_XML_Document::getEncoding</refname>
<refpurpose>
Returns encoding string.
Returns encoding string
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>SDO_DAS_XML_Document::getEncoding</methodname>
<type>string</type><methodname>SDO_DAS_XML_Document::getEncoding</methodname>
<void/>
</methodsynopsis>

View file

@ -1,20 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getNoNamespaceSchemaLocation">
<refnamediv>
<refname>SDO_DAS_XML_Document::getNoNamespaceSchemaLocation</refname>
<refpurpose>
Returns no namespace schema location.
Returns no namespace schema location
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>
SDO_DAS_XML_Document::getNoNamespaceSchemaLocation
</methodname>
<type>string</type><methodname>SDO_DAS_XML_Document::getNoNamespaceSchemaLocation</methodname>
<void/>
</methodsynopsis>

View file

@ -1,22 +1,23 @@
<?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-XML-Document-getRootDataObject">
<refnamediv>
<refname>SDO_DAS_XML_Document::getRootDataObject</refname>
<refpurpose> Returns the root SDO_DataObject.
<refpurpose>
Returns the root SDO_DataObject
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DataObject</type>
<methodname>SDO_DAS_XML_Document::getRootDataObject</methodname>
<type>SDO_DataObject</type><methodname>SDO_DAS_XML_Document::getRootDataObject</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para> Returns the root SDO_DataObject.
<para>
Returns the root SDO_DataObject.
</para>
</refsect1>
@ -27,7 +28,8 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para> Returns the root SDO_DataObject.
<para>
Returns the root SDO_DataObject.
</para>
</refsect1>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getRootElementName">
<refnamediv>
<refname>SDO_DAS_XML_Document::getRootElementName</refname>
<refpurpose>
Returns root element's name.
Returns root element's name
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>SDO_DAS_XML_Document::getRootElementName</methodname>
<type>string</type><methodname>SDO_DAS_XML_Document::getRootElementName</methodname>
<void/>
</methodsynopsis>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getRootElementURI">
<refnamediv>
<refname>SDO_DAS_XML_Document::getRootElementURI</refname>
<refpurpose>
Returns root element's URI string.
Returns root element's URI string
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>SDO_DAS_XML_Document::getRootElementURI</methodname>
<type>string</type><methodname>SDO_DAS_XML_Document::getRootElementURI</methodname>
<void/>
</methodsynopsis>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getSchemaLocation">
<refnamediv>
<refname>SDO_DAS_XML_Document::getSchemaLocation</refname>
<refpurpose>
Returns schema location.
Returns schema location
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>SDO_DAS_XML_Document::getSchemaLocation</methodname>
<type>string</type><methodname>SDO_DAS_XML_Document::getSchemaLocation</methodname>
<void/>
</methodsynopsis>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getXMLDeclaration">
<refnamediv>
<refname>SDO_DAS_XML_Document::getXMLDeclaration</refname>
<refpurpose>
Returns whether the xml declaration is set or not.
Returns whether the xml declaration is set or not
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type>
<methodname>SDO_DAS_XML_Document::getXMLDeclaration</methodname>
<type>bool</type><methodname>SDO_DAS_XML_Document::getXMLDeclaration</methodname>
<void/>
</methodsynopsis>

View file

@ -1,18 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getXMLVersion">
<refnamediv>
<refname>SDO_DAS_XML_Document::getXMLVersion</refname>
<refpurpose>
Returns xml declaration string.
Returns xml declaration string
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>SDO_DAS_XML_Document::getXMLVersion</methodname>
<type>string</type><methodname>SDO_DAS_XML_Document::getXMLVersion</methodname>
<void/>
</methodsynopsis>

View file

@ -1,27 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setEncoding">
<refnamediv>
<refname>SDO_DAS_XML_Document::setEncoding</refname>
<refpurpose>
Sets the given string as encoding.
Sets the given string as encoding
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>SDO_DAS_XML_Document::setEncoding</methodname>
<methodparam>
<type>string</type>
<parameter>encoding</parameter>
</methodparam>
<type>void</type><methodname>SDO_DAS_XML_Document::setEncoding</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given string as encoding.
Sets the given string as encoding.
</para>
</refsect1>

View file

@ -1,22 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setNoNamespaceSchemaLocation">
<refnamediv>
<refname>SDO_DAS_XML_Document::setNoNamespaceSchemaLocation</refname>
<refpurpose>
Sets the given string as no namespace schema location.
Sets the given string as no namespace schema location
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>SDO_DAS_XML_Document::setNoNamespaceSchemaLocation</methodname>
<methodparam>
<type>string</type>
<parameter>nnschemaLocation</parameter>
</methodparam>
<type>void</type><methodname>SDO_DAS_XML_Document::setNoNamespaceSchemaLocation</methodname>
<methodparam><type>string</type><parameter>nnschemaLocation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;

View file

@ -1,27 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setSchemaLocation">
<refnamediv>
<refname>SDO_DAS_XML_Document::setSchemaLocation</refname>
<refpurpose>
Sets the given string as schema location.
Sets the given string as schema location
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>SDO_DAS_XML_Document::setSchemaLocation</methodname>
<methodparam>
<type>string</type>
<parameter>schemaLocation</parameter>
</methodparam>
<type>void</type><methodname>SDO_DAS_XML_Document::setSchemaLocation</methodname>
<methodparam><type>string</type><parameter>schemaLocation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given string as schema location.
Sets the given string as schema location.
</para>
</refsect1>

View file

@ -1,27 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setXMLDeclaration">
<refnamediv>
<refname>SDO_DAS_XML_Document::setXMLDeclaration</refname>
<refpurpose>
Sets the xml declaration.
Sets the xml declaration
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>SDO_DAS_XML_Document::setXMLDeclaration</methodname>
<methodparam>
<type>bool</type>
<parameter>xmlDeclatation</parameter>
</methodparam>
<type>void</type><methodname>SDO_DAS_XML_Document::setXMLDeclaration</methodname>
<methodparam><type>bool</type><parameter>xmlDeclatation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given given boolean value for xml declaration.
Sets the given boolean value for xml declaration.
Pass TRUE to set it and FLASE to not to unset it.
</para>
@ -36,7 +32,7 @@
</term>
<listitem>
<para>
boolean value to set the XML declaration.
Boolean value to set the XML declaration.
</para>
</listitem>
</varlistentry>
@ -46,7 +42,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
None.
</para>
</refsect1>

View file

@ -1,27 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setXMLVersion">
<refnamediv>
<refname>SDO_DAS_XML_Document::setXMLVersion</refname>
<refpurpose>
Sets the given string as xml version.
Sets the given string as xml version
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>SDO_DAS_XML_Document::setXMLVersion</methodname>
<methodparam>
<type>string</type>
<parameter>xmlVersion</parameter>
</methodparam>
<type>void</type><methodname>SDO_DAS_XML_Document::setXMLVersion</methodname>
<methodparam><type>string</type><parameter>xmlVersion</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given string as xml version.
Sets the given string as xml version.
</para>
</refsect1>

View file

@ -1,22 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-create">
<refnamediv>
<refname>SDO_DAS_XML::create</refname>
<refpurpose>
To create SDO_DAS_XML object for a given schema file.
To create SDO_DAS_XML object for a given schema file
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DAS_XML</type>
<methodname>SDO_DAS_XML::create</methodname>
<methodparam>
<type>string</type>
<parameter>xsd_file</parameter>
</methodparam>
<type>SDO_DAS_XML</type><methodname>SDO_DAS_XML::create</methodname>
<methodparam><type>string</type><parameter>xsd_file</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;

View file

@ -1,26 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-createDataObject">
<refnamediv>
<refname>SDO_DAS_XML::createDataObject</refname>
<refpurpose>
Creates SDO_DataObject for a given namespace URI and type name.
Creates SDO_DataObject for a given namespace URI and type name
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DataObject</type>
<methodname>SDO_DAS_XML::createDataObject</methodname>
<methodparam>
<type>string</type>
<parameter>namespace_uri</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>type_name</parameter>
</methodparam>
<type>SDO_DataObject</type><methodname>SDO_DAS_XML::createDataObject</methodname>
<methodparam><type>string</type><parameter>namespace_uri</parameter></methodparam>
<methodparam><type>string</type><parameter>type_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;

View file

@ -1,22 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-loadFromFile">
<refnamediv>
<refname>SDO_DAS_XML::loadFromFile</refname>
<refpurpose>
Returns SDO_DAS_XML_Document object for a given path to xml instance document.
Returns SDO_DAS_XML_Document object for a given path to xml instance document
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_XMLDocument</type>
<methodname>SDO_DAS_XML::loadFromFile</methodname>
<methodparam>
<type>string</type>
<parameter>xml_file</parameter>
</methodparam>
<type>SDO_XMLDocument</type><methodname>SDO_DAS_XML::loadFromFile</methodname>
<methodparam><type>string</type><parameter>xml_file</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
@ -75,7 +71,7 @@
</term>
<listitem>
<para>
Thrown if the a property within a type is not defined
Thrown if a property within a type is not defined
in the underlying model.
</para>
</listitem>

View file

@ -1,22 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-loadFromString">
<refnamediv>
<refname>SDO_DAS_XML::loadFromString</refname>
<refpurpose>
Returns SDO_DAS_XML_Document for a given xml instance string.
Returns SDO_DAS_XML_Document for a given xml instance string
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DAS_XML_Document</type>
<methodname>SDO_DAS_XML::loadFromString</methodname>
<methodparam>
<type>string</type>
<parameter>xml_string</parameter>
</methodparam>
<type>SDO_DAS_XML_Document</type><methodname>SDO_DAS_XML::loadFromString</methodname>
<methodparam><type>string</type><parameter>xml_string</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;

View file

@ -1,34 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-saveDataObjectToFile">
<refnamediv>
<refname>SDO_DAS_XML::saveDataObjectToFile</refname>
<refpurpose>
Saves the SDO_DataObject object to File.
Saves the SDO_DataObject object to File
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>SDO_DAS_XML::saveDataObjectToFile</methodname>
<methodparam>
<type>SDO_DataObject</type>
<parameter>do</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>root_uri</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>root_name</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>xml_file</parameter>
</methodparam>
<type>void</type><methodname>SDO_DAS_XML::saveDataObjectToFile</methodname>
<methodparam><type>SDO_DataObject</type><parameter>do</parameter></methodparam>
<methodparam><type>string</type><parameter>root_uri</parameter></methodparam>
<methodparam><type>string</type><parameter>root_name</parameter></methodparam>
<methodparam><type>string</type><parameter>xml_file</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;

View file

@ -1,30 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-saveDataObjectToString">
<refnamediv>
<refname>SDO_DAS_XML::saveDataObjectToString</refname>
<refpurpose>
Saves the SDO_DataObject object to string.
Saves the SDO_DataObject object to string
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>SDO_DAS_XML::saveDataObjectToString</methodname>
<methodparam>
<type>SDO_DataObject</type>
<parameter>do</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>root_uri</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>root_name</parameter>
</methodparam>
<type>string</type><methodname>SDO_DAS_XML::saveDataObjectToString</methodname>
<methodparam><type>SDO_DataObject</type><parameter>do</parameter></methodparam>
<methodparam><type>string</type><parameter>root_uri</parameter></methodparam>
<methodparam><type>string</type><parameter>root_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
@ -43,7 +33,7 @@
</term>
<listitem>
<para>
DataObject, which needs to be saves as an XML File.
DataObject, which needs to be saves as an XML string.
</para>
</listitem>
</varlistentry>
@ -73,7 +63,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
xml string
xml string.
</para>
</refsect1>

View file

@ -1,26 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-saveDocumentToFile">
<refnamediv>
<refname>SDO_DAS_XML::saveDocumentToFile</refname>
<refpurpose>
Saves the SDO_DAS_XML_Document object to a file.
Saves the SDO_DAS_XML_Document object to a file
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type>
<methodname>SDO_DAS_XML::saveDocumentToFile</methodname>
<methodparam>
<type>SDO_XMLDocument</type>
<parameter>xdoc</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>xml_file</parameter>
</methodparam>
<type>void</type><methodname>SDO_DAS_XML::saveDocumentToFile</methodname>
<methodparam><type>SDO_XMLDocument</type><parameter>xdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>xml_file</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
@ -59,6 +52,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
</para>
</refsect1>

View file

@ -1,22 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-saveDocumentToString">
<refnamediv>
<refname>SDO_DAS_XML::saveDocumentToString</refname>
<refpurpose>
Saves the SDO_DAS_XML_Document object to a string.
Saves the SDO_DAS_XML_Document object to a string
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>SDO_DAS_XML::saveDocumentToString</methodname>
<methodparam>
<type>SDO_XMLDocument</type>
<parameter>xdoc</parameter>
</methodparam>
<type>string</type><methodname>SDO_DAS_XML::saveDocumentToString</methodname>
<methodparam><type>SDO_XMLDocument</type><parameter>xdoc</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;