/** Build the package index.
*
* @param Doclet doclet
*/
function packageIndexWriter(&$doclet)
{
parent::htmlWriter($doclet);
$phpdoctor =& $this->_doclet->phpdoctor();
$this->_sections[0] = array('title' => 'Overview', 'selected' => TRUE);
$this->_sections[1] = array('title' => 'Namespace');
$this->_sections[2] = array('title' => 'Class');
//$this->_sections[3] = array('title' => 'Use');
if ($phpdoctor->getOption('tree')) {
$this->_sections[4] = array('title' => 'Tree', 'url' => 'overview-tree.html');
}
if ($doclet->includeSource()) {
$this->_sections[5] = array('title' => 'Files', 'url' => 'overview-files.html');
}
$this->_sections[6] = array('title' => 'Deprecated', 'url' => 'deprecated-list.html');
$this->_sections[7] = array('title' => 'Todo', 'url' => 'todo-list.html');
$this->_sections[8] = array('title' => 'Index', 'url' => 'index-all.html');
ob_start();
echo "<hr>\n\n";
echo '<h1>' . $this->_doclet->docTitle() . "</h1>\n\n";
$rootDoc =& $this->_doclet->rootDoc();
$textTag =& $rootDoc->tags('@text');
if ($textTag) {
$description = $this->_processInlineTags($textTag, TRUE);
if ($description) {
echo '<div class="comment">', $description, "</div>\n\n";
echo '<dl><dt>See:</dt><dd><b><a href="#overview_description">Description</a></b></dd></dl>' . "\n\n";
}
}
echo '<table class="title">' . "\n";
echo '<tr><th colspan="2" class="title">Namespaces</th></tr>' . "\n";
$packages =& $rootDoc->packages();
ksort($packages);
foreach ($packages as $name => $package) {
$textTag =& $package->tags('@text');
echo '<tr><td class="name"><a href="' . $package->asPath() . '/package-summary.html">' . $package->name() . '</a></td>';
echo '<td class="description">' . strip_tags($this->_processInlineTags($textTag, TRUE), '<a><b><strong><u><em>') . '</td></tr>' . "\n";
}
echo '</table>' . "\n\n";
$textTag =& $rootDoc->tags('@text');
if ($textTag) {
$description = $this->_processInlineTags($textTag);
if ($description) {
echo '<div class="comment" id="overview_description">', $description, "</div>\n\n";
}
}
echo "<hr>\n\n";
$this->_output = ob_get_contents();
ob_end_clean();
$this->_write('overview-summary.html', 'Overview', TRUE);
}
