rootDoc::rootDoc PHP Method

    public function rootDoc(&$phpdoctor)
    {
        // set a reference to application object
        $this->_phpdoctor =& $phpdoctor;
        $overview = $phpdoctor->getOption('overview');
        // parse overview file
        if (isset($overview)) {
            if (is_file($overview)) {
                $phpdoctor->message('Reading overview file "' . $overview . '".');
                if ($text = $this->getFileContents($overview)) {
                    $this->_data = $phpdoctor->processDocComment('/** ' . $text . ' */', $this);
                    $this->mergeData();
                }
            } else {
                $phpdoctor->warning('Could not find overview file "' . $overview . '".');
            }
        }
    }