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

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)