<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Gets doc comments</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectionclass.getdefaultproperties.html">ReflectionClass::getDefaultProperties</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectionclass.getendline.html">ReflectionClass::getEndLine</a></div>
<div class="up"><a href="class.reflectionclass.html">ReflectionClass</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="reflectionclass.getdoccomment" class="refentry">
<div class="refnamediv">
<h1 class="refname">ReflectionClass::getDocComment</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">ReflectionClass::getDocComment</span> — <span class="dc-title">Gets doc comments</span></p>
</div>
<div class="refsect1 description" id="refsect1-reflectionclass.getdoccomment-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>ReflectionClass::getDocComment</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Gets doc comments from a class.
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-reflectionclass.getdoccomment-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-reflectionclass.getdoccomment-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The doc comment if it exists, otherwise <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 examples" id="refsect1-reflectionclass.getdoccomment-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5184">
<p><strong>Example #1 <span class="methodname"><strong>ReflectionClass::getDocComment()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/** <br />* A test class<br />*<br />* @param foo bar<br />* @return baz<br />*/<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">TestClass </span><span style="color: #007700">{ }<br /><br /></span><span style="color: #0000BB">$rc </span><span style="color: #007700">= new </span><span style="color: #0000BB">ReflectionClass</span><span style="color: #007700">(</span><span style="color: #DD0000">'TestClass'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$rc</span><span style="color: #007700">-></span><span style="color: #0000BB">getDocComment</span><span style="color: #007700">())<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(55) "/**
* A test class
*
* @param foo bar
* @return baz
*/"
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-reflectionclass.getdoccomment-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="reflectionclass.getname.html" class="methodname" rel="rdfs-seeAlso">ReflectionClass::getName()</a> - Gets class name</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="reflectionclass.getdefaultproperties.html">ReflectionClass::getDefaultProperties</a></div>
<div class="next" style="text-align: right; float: right;"><a href="reflectionclass.getendline.html">ReflectionClass::getEndLine</a></div>
<div class="up"><a href="class.reflectionclass.html">ReflectionClass</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
