From e3a7e8b0af9457867fdd13a4831f8f65ee671195 Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Fri, 4 Jul 2014 20:57:09 +0000
Subject: [PATCH] Document DateTimeImmutable::modify

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334116 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../datetime/datetimeimmutable/modify.xml     | 26 ++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/reference/datetime/datetimeimmutable/modify.xml b/reference/datetime/datetimeimmutable/modify.xml
index f33df38532..48895b5cec 100644
--- a/reference/datetime/datetimeimmutable/modify.xml
+++ b/reference/datetime/datetimeimmutable/modify.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="datetimeimmutable.modify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>DateTimeImmutable::modify</refname>
-  <refpurpose>Alters the timestamp</refpurpose>
+  <refpurpose>Creates a new object with modified timestamp</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -14,8 +14,28 @@
    <methodparam><type>string</type><parameter>modify</parameter></methodparam>
   </methodsynopsis>
   <para>
-   Like <methodname>DateTime::modify</methodname> but works with
-   <classname>DateTimeImmutable</classname>.
+   Creates a new <type>DateTimeImmutable</type> object with modified timestamp.
+   The original object is not modified.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   &date.datetime.description.modified;
+   <varlistentry>
+    <term><parameter>modify</parameter></term>
+    <listitem>
+     <para>&date.formats.parameter;</para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the newly created object&return.falseforfailure;.
   </para>
  </refsect1>