reflectionclass.getdoccomment(3) php man page | unix.com

Man Page: reflectionclass.getdoccomment

Operating Environment: php

Section: 3

REFLECTIONCLASS.GETDOCCOMMENT(3)					 1					  REFLECTIONCLASS.GETDOCCOMMENT(3)

ReflectionClass::getDocComment - Gets doc comments

SYNOPSIS
public string ReflectionClass::getDocComment (void )
DESCRIPTION
Gets doc comments from a class. Warning This function is currently not documented; only its argument list is available.
PARAMETERS
This function has no parameters.
RETURN VALUES
The doc comment if it exists, otherwise FALSE
EXAMPLES
Example #1 ReflectionClass::getDocComment example <?php /** * A test class * * @param foo bar * @return baz */ class TestClass { } $rc = new ReflectionClass('TestClass'); var_dump($rc->getDocComment()) ?> The above example will output: string(55) "/** * A test class * * @param foo bar * @return baz */"
SEE ALSO
ReflectionClass::getName. PHP Documentation Group REFLECTIONCLASS.GETDOCCOMMENT(3)
Related Man Pages
reflectionclass(3) - php
reflectionfunction(3) - php
reflectionproperty(3) - php
class_alias(3) - php
reflectionclass.newinstanceargs(3) - php
Similar Topics in the Unix Linux Community
Rules for Homework &amp; Coursework Questions Forum
UNIX.COM 2017 Year End Summary
Coming Soon: Upgrade Forum Software (Dec 31 - Jan 1)
New Code Tags (Syntax Highlighting)
Please Welcome Ravinder Singh to the Moderation Team