From 4d8bee3f1d6e05b6c11dbdccc31aa8f12396f72d Mon Sep 17 00:00:00 2001
From: Thomas Punt <tpunt@php.net>
Date: Wed, 6 Jan 2016 20:03:57 +0000
Subject: [PATCH] Finish documenting ReflectionProperty::getDocComment

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338413 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../reflectionproperty/getdoccomment.xml      | 49 ++++++++++++++++---
 1 file changed, 42 insertions(+), 7 deletions(-)

diff --git a/reference/reflection/reflectionproperty/getdoccomment.xml b/reference/reflection/reflectionproperty/getdoccomment.xml
index addce6ead1..dc10457ffc 100644
--- a/reference/reflection/reflectionproperty/getdoccomment.xml
+++ b/reference/reflection/reflectionproperty/getdoccomment.xml
@@ -4,7 +4,7 @@
 <refentry xml:id="reflectionproperty.getdoccomment" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>ReflectionProperty::getDocComment</refname>
-  <refpurpose>Gets doc comment</refpurpose>
+  <refpurpose>Gets the property doc comment</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -14,11 +14,8 @@
    <void />
   </methodsynopsis>
   <para>
-   Gets the doc comment.
+   Gets the doc comment for a property.
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +26,43 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   The doc comment.
+   The property doc comment.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><methodname>ReflectionProperty::__construct</methodname> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+class Str
+{
+    /**
+     * @var int  The length of the string
+     */
+    public $length  = 5;
+}
+
+// Create an instance of the ReflectionProperty class
+$prop = new ReflectionProperty('Str', 'length');
+
+var_dump($prop->getDocComment());
+
+?>
+]]>
+    </programlisting>
+    &example.outputs.similar;
+    <screen>
+<![CDATA[
+string(53) "/**
+     * @var int  The length of the string
+     */"
+]]>
+    </screen>
+   </example>
   </para>
  </refsect1>
 
@@ -37,7 +70,9 @@
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><methodname>ReflectionProperty::export</methodname></member>
+    <member><methodname>ReflectionProperty::getModifiers</methodname></member>
+    <member><methodname>ReflectionProperty::getName</methodname></member>
+    <member><methodname>ReflectionProperty::getValue</methodname></member>
    </simplelist>
   </para>
  </refsect1>