Nette\PhpGenerator\ClassType::getDocuments PHP Method

getDocuments() public method

Deprecation:
public getDocuments ( )
    public function getDocuments()
    {
        trigger_error(__METHOD__ . '() is deprecated, use similar getComment()', E_USER_DEPRECATED);
        return $this->comment ? [$this->comment] : [];
    }

Usage Example

Example #1
0
 private function addAutoGeneratedWarning(ClassType $class)
 {
     if (count($class->getDocuments())) {
         $class->addComment("");
     }
     $class->addComment("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")->addComment("!!!                                                     !!!")->addComment("!!!   THIS CLASS HAS BEEN AUTO-GENERATED, DO NOT EDIT   !!!")->addComment("!!!                                                     !!!")->addComment("!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!");
 }