Minor cleanup

phpdotnet/phd/Autoloader.php

@@ -33,7 +33,7 @@ public static function autoload($name)
     }
 
     /**
-     * @var array<string> Absolute pathnames to package directories
+     * @param array<string> $dirs Absolute pathnames to package directories
      */
     public static function setPackageDirs(array $dirs): void {
         self::$package_dirs = $dirs;

phpdotnet/phd/Config.php

@@ -28,16 +28,16 @@ class Config
     public string $outputFilename = '';
     /** @var resource */
     public $phpErrorOutput = \STDERR;
-    public string $phpErrorColor = '01;31'; // Red
+    public string|false $phpErrorColor = '01;31'; // Red
     /** @var resource */
     public $userErrorOutput = \STDERR;
-    public string $userErrorColor = '01;33'; // Yellow
+    public string|false $userErrorColor = '01;33'; // Yellow
     /** @var resource */
     public $phdInfoOutput = \STDOUT;
-    public string $phdInfoColor = '01;32'; // Green
+    public string|false $phdInfoColor = '01;32'; // Green
     /** @var resource */
     public $phdWarningOutput = \STDOUT;
-    public string $phdWarningColor = '01;35'; // Magenta
+    public string|false $phdWarningColor = '01;35'; // Magenta
     public string $highlighter = 'phpdotnet\\phd\\Highlighter';
     /** @var array<string> */
     public array $package =['Generic'];
@@ -68,7 +68,7 @@ public function __construct() {
     /**
      * Sets one or more configuration options from an array
      * 
-     * @param array<string, mixed>
+     * @param array<string, mixed> $configOptions
      */
     public function init(array $configOptions): void {
         foreach ($configOptions as $option => $value) {

phpdotnet/phd/Format.php

@@ -89,7 +89,7 @@ abstract public function CDATA($value);
      * @param integer $type  Format of description, Format::SDESC or
      *                       Format::LDESC
      *
-     * @return string Relative or absolute URI to access $for
+     * @return string|null|void Relative or absolute URI to access $for
      */
     abstract public function createLink(
         $for, &$desc = null, $type = Format::SDESC
@@ -122,7 +122,7 @@ abstract public function appendData($data);
      *     Value is either Render::OPEN or Render::CLOSE
      *
      * @param integer $event Event flag (see Render class)
-     * @param mixed   $val   Additional value flag. Depends
+     * @param mixed   $value Additional value flag. Depends
      *                       on $event type
      *
      * @return void

phpdotnet/phd/Format/Abstract/PDF.php

@@ -354,7 +354,7 @@ public function add($type, $option = null) {
                 $this->lineJump();
                 break;
             case self::DRAW_LINE:
-                $this->traceLine($option);
+                $this->traceLine();
                 break;
             case self::LINE_JUMP:
                 if ($option)

phpdotnet/phd/Highlighter.php

@@ -31,7 +31,7 @@ class Highlighter
     *
     * @param string $format Output format (pdf, xhtml, troff, ...)
     *
-    * @return PhDHighlighter Highlighter object
+    * @return Highlighter Highlighter object
     */
     public static function factory($format)
     {
@@ -75,7 +75,7 @@ public function highlight($text, $role, $format)
             } catch (\ParseException $e) {
                 trigger_error(vsprintf("Parse error while highlighting PHP code: %s\nText: %s", [(string) $e, $text]), E_USER_WARNING);
 
-                return '<pre class="'. ($role ? $role . 'code' : 'programlisting') .'">'
+                return '<pre class="'. $role . 'code">'
                     . htmlspecialchars($text, ENT_QUOTES, 'UTF-8')
                     . "</pre>\n";
             }

phpdotnet/phd/Highlighter/GeSHi.php

@@ -51,7 +51,7 @@ class Highlighter_GeSHi extends Highlighter
     *
     * @param string $format Output format (pdf, xhtml, troff, ...)
     *
-    * @return PhDHighlighter Highlighter object
+    * @return Highlighter Highlighter object
     */
     public static function factory($format)
     {

phpdotnet/phd/Highlighter/GeSHi11x.php

@@ -45,7 +45,7 @@ class Highlighter_GeSHi11x extends Highlighter
     *
     * @param string $format Output format (pdf, xhtml, troff, ...)
     *
-    * @return PhDHighlighter Highlighter object
+    * @return Highlighter Highlighter object
     */
     public static function factory($format)
     {
@@ -122,7 +122,7 @@ public function highlight($text, $role, $format)
      *
      * @param string $role   Source code role to use (php, xml, html, ...)
      *
-     * @return string Language name for GeSHi or null if not found.
+     * @return ?string Language name for GeSHi or null if not found.
      */
     protected function getGeSHiLanguage($role)
     {

phpdotnet/phd/Options/Handler.php

@@ -242,7 +242,7 @@ public function option_outputfilename(string $k, mixed $v): array
     }
 
     /**
-     * @return array<string, string>
+     * @return array<string, array<string>>
      */
     public function option_p(string $k, mixed $v): array
     {
@@ -288,15 +288,15 @@ public function option_package(string $k, mixed $v): array
     }
 
     /**
-     * @return array<string, string>
+     * @return array<string, true>
      */
     public function option_q(string $k, mixed $v): array
     {
         return $this->option_quit($k, $v);
     }
 
     /**
-     * @return array<string, string>
+     * @return array<string, true>
      */
     public function option_quit(string $k, mixed $v): array
     {

phpdotnet/phd/Package/Generic/TocFeed.php

@@ -201,7 +201,7 @@ public function close()
      *     Value is either Render::OPEN or Render::CLOSE
      *
      * @param integer $event Event flag (see Render class)
-     * @param mixed   $val   Additional value flag. Depends
+     * @param mixed   $value Additional value flag. Depends
      *                       on $event type
      *
      * @return void
@@ -490,7 +490,7 @@ public function CDATA($value)
      * to overwrite this method to return full absolute URIs,
      * or modify $targetBaseUri.
      *
-     * @param string  $id    Chunk ID
+     * @param string  $for   Chunk ID
      * @param string  &$desc Description of link, to be filled if neccessary.
      *                       Not used here.
      * @param integer $type  Format of description, Format::SDESC or

phpdotnet/phd/Package/Generic/XHTML.php

@@ -82,7 +82,6 @@ abstract class Package_Generic_XHTML extends Format_Abstract_XHTML {
         'constructorsynopsis'   => 'format_methodsynopsis',
         'destructorsynopsis'    => 'format_methodsynopsis',
         'emphasis'              => 'format_emphasis',
-        'enumname'              => 'span',
         'entry'                 => array (
             /* DEFAULT */          'format_entry',
             'row'               => array(
@@ -137,7 +136,6 @@ abstract class Package_Generic_XHTML extends Format_Abstract_XHTML {
         'literal'               => 'format_literal',
         'literallayout'         => 'pre',
         'link'                  => 'format_link',
-        'xref'                  => 'format_xref',
         'manvolnum'             => 'format_manvolnum',
         'inlinemediaobject'     => 'format_mediaobject',
         'mediaobject'           => 'format_mediaobject',
@@ -759,7 +757,7 @@ public function format_literal($open, $name, $attrs)
     public function format_literal_text($value, $tag) {
         switch ($this->getRole()) {
             case 'infdec':
-                $value = (float)$value;
+                $value = (string) (float)$value;
                 $p = strpos($value, '.');
                 $str = substr($value, 0, $p + 1);
                 $str .= '<span style="text-decoration: overline;">';
@@ -840,7 +838,7 @@ public function format_container_chunk_top($open, $name, $attrs, $props) {
         $this->CURRENT_CHUNK = $id;
         $this->notify(Render::CHUNK, Render::CLOSE);
         $toc = "";
-        if (!in_array($id, $this->TOC_WRITTEN ?? [])) {
+        if (!in_array($id, $this->TOC_WRITTEN)) {
             $toc = $this->createTOC($id, $name, $props);
         }
 
@@ -877,7 +875,7 @@ public function format_container_chunk_below($open, $name, $attrs, $props) {
         }
 
         $toc = '<ol>';
-        if (!in_array($id, $this->TOC_WRITTEN ?? [])) {
+        if (!in_array($id, $this->TOC_WRITTEN)) {
             $toc = $this->createTOC($id, $name, $props);
         }
         $toc .= "</ol>\n";
@@ -2005,8 +2003,8 @@ public function format_table($open, $name, $attrs, $props) {
         if (isset($this->cchunk["tablefootnotes"]) && $this->cchunk["tablefootnotes"]) {
             $opts = array(Reader::XMLNS_DOCBOOK => array());
 
-            $str =  $this->format_tbody(true, "footnote", $opts, $props);
-            $str .= $this->format_row(true, "footnote", $opts, $props);
+            $str =  $this->format_tbody(true, "footnote", $opts);
+            $str .= $this->format_row(true, "footnote", $opts);
             $str .= $this->format_entry(true, "footnote", $opts, $props+array("colspan" => $this->getColCount()));
 
             foreach ($this->cchunk["tablefootnotes"] as $k => $noteid) {
@@ -2017,8 +2015,8 @@ public function format_table($open, $name, $attrs, $props) {
 
             }
             $str .= $this->format_entry(false, "footnote", $opts, $props);
-            $str .= $this->format_row(false, "footnote", $opts, $props);
-            $str .= $this->format_tbody(false, "footnote", $opts, $props);
+            $str .= $this->format_row(false, "footnote", $opts);
+            $str .= $this->format_tbody(false, "footnote", $opts);
 
             $this->cchunk["tablefootnotes"] = $this->dchunk["tablefootnotes"];
         }

phpdotnet/phd/Package/IDE/API.php

@@ -83,7 +83,7 @@ public function __construct($dir)
      * Loads a function file and returns a Package_IDE_API_Function.
      *
      * @param string $filename File of the function.
-     * @return Package_IDE_API_Function Object representing the function.
+     * @return ?Package_IDE_API_Function Object representing the function.
      */
     private function loadFunction($filename)
     {

phpdotnet/phd/Package/IDE/API/Function.php

@@ -108,7 +108,7 @@ class Package_IDE_API_Function
     /**
      * Creates a new instance of Package_IDE_API_Function.
      *
-     * @param SimpleXMLElement $xmlElement A new SimpleXMLElement
+     * @param \SimpleXMLElement $xmlElement A new SimpleXMLElement
      *        of the function file.
      */
     public function __construct(\SimpleXMLElement $xmlElement)

phpdotnet/phd/Package/IDE/API/Param.php

@@ -61,7 +61,7 @@ class Package_IDE_API_Param
     /**
      * Creates a new instance.
      *
-     * @param SimpleXMLElement $xmlElement
+     * @param \SimpleXMLElement $xmlElement
      */
     public function __construct(\SimpleXMLElement $xmlElement)
     {

phpdotnet/phd/Package/IDE/Base.php

@@ -121,7 +121,10 @@ function writeChunk() {
     public function renderHTML() {
         static $format = null;
         if ($format == null) {
-            $format = new Package_Generic_ChunkedXHTML($this->config);
+            $format = new Package_Generic_ChunkedXHTML(
+                $this->config,
+                $this->outputHandler
+            );
         }
         return $format->parse(trim(ReaderKeeper::getReader()->readInnerXML()));
     }

phpdotnet/phd/Package/IDE/demo.php

@@ -2,7 +2,7 @@
 <?php
 use phpdotnet\phd as PhD;
 
-define('__INSTALLDIR__', '@php_dir@' == '@'.'php_dir@' ? dirname(dirname(dirname(dirname(__DIR__)))) : '@php_dir@');
+require dirname(__DIR__, 2) . 'constants.php';
 define('DS', DIRECTORY_SEPARATOR);
 
 require __INSTALLDIR__ . DS . 'phpdotnet' . DS . 'phd' . DS . 'Autoloader.php';
@@ -11,7 +11,8 @@
 spl_autoload_register(array("phpdotnet\\phd\\Autoloader", "autoload"));
 
 //FIXME Remove this call to Config
-PhD\Config::init(array());
+$config = new PhD\Config;
+$config->init(array());
 
 function usage()
 {

phpdotnet/phd/Package/PEAR/CHM.php

@@ -258,7 +258,7 @@ protected function appendChm($name, $ref, $hasChild) {
 			if ($hasChild) fwrite($this->hhcStream, "{$this->offset(2)}<ul>\n");
 			fwrite($this->hhkStream, "      <li><object type=\"text/sitemap\">\n" .
 				"          <param name=\"Local\" value=\"{$ref}\">\n" .
-				"          <param name=\"Name\" value=\"" . htmlentities(self::cleanIndexName($name, ENT_COMPAT, "UTF-8")) . "\">\n" .
+				"          <param name=\"Name\" value=\"" . htmlentities(self::cleanIndexName($name), ENT_COMPAT, "UTF-8") . "\">\n" .
 				"        </object>\n");
 		} elseif ($this->flags & Render::CLOSE) {
 			if ($hasChild) {

phpdotnet/phd/Package/PEAR/XHTML.php

@@ -146,7 +146,6 @@ abstract class Package_PEAR_XHTML extends Package_Generic_XHTML {
         'phd:toc'               => 'format_phd_toc',
         'phpdoc:exception'      => 'format_exception_chunk',
         'releaseinfo'           => 'format_div',
-        'replaceable'           => 'span',
         'refname'               => 'format_refname',
         'refnamediv'            => 'format_suppressed_tags',
         'refpurpose'            => 'format_refpurpose',
@@ -678,8 +677,8 @@ public function format_phd_pearapi_text($value, $tag)
     * Highlighting an such is done in format_programlisting_text()
     *
     *
-    * @param string $value Value of the text to format.
-    * @param string $tag   Tag name
+    * @param string $open  Whether we should open or close this element
+    * @param string $name  Tag name
     * @param array  $attrs Array of attributes
     *
     * @return string Generated programlisting html

phpdotnet/phd/Package/PHP/EnhancedCHM.php

@@ -137,6 +137,7 @@ public function footer($id) {
                 if ($noteUser) {
                     $noteUser = '<strong class="user">' . htmlspecialchars($noteUser) . '</strong>';
                 }
+                $noteTimestamp = $noteTimestamp === "" ? null : (int) $noteTimestamp;
                 $noteDate = '<a href="#' . $noteId . '" class="date">' . date("d-M-Y h:i", $noteTimestamp) . '</a>';
                 $anchor   = '<a name="' . $noteId . '""></a>';
 

phpdotnet/phd/Package/PHP/Manpage.php

@@ -4,7 +4,6 @@
 class Package_PHP_Manpage extends Package_Generic_Manpage {
 
     protected $elementmap = array(
-        'phpdoc:varentry'               => 'format_chunk',
         'phpdoc:classref'               => 'format_chunk',
         'phpdoc:exception'              => 'format_chunk',
         'phpdoc:exceptionref'           => 'format_chunk',
@@ -64,7 +63,7 @@ public function update($event, $value = null) {
             }
             break;
         default:
-            return parent::update($event, $value);
+            parent::update($event, $value);
             break;
         }
     }

phpdotnet/phd/Package/PHP/XHTML.php

@@ -668,7 +668,6 @@ public function format_type_methodparam_text($type, $tagname) {
 
     public function format_type_text($type, $tagname) {
         $t = strtr($this->normalizeFQN($type), ["_" => "-", "\\" => "-"]);
-        $fragment = "";
 
         switch($t) {
         case "void":
@@ -717,10 +716,10 @@ public function format_type_text($type, $tagname) {
 
         $classNames = ($type === "?") ? ($tagname . ' null') : ($tagname . ' ' . ltrim($type, "\\"));
         if ($href && $this->chunked) {
-            return '<a href="' .$href. $this->getExt().($fragment ? "#$fragment" : ""). '" class="' . $classNames . '">' .$type. '</a>';
+            return '<a href="' .$href. $this->getExt(). '" class="' . $classNames . '">' .$type. '</a>';
         }
         if ($href) {
-            return '<a href="#' .($fragment ? $fragment : $href). '" class="' . $classNames . '">' .$type. '</a>';
+            return '<a href="#' .$href. '" class="' . $classNames . '">' .$type. '</a>';
         }
         return '<span class="' . $classNames . '">' .$type. '</span>';
     }

phpdotnet/phd/ReaderKeeper.php

@@ -35,7 +35,7 @@ public static function getReader()
     /**
      * Removes the reader from the top of the stack.
      *
-     * @return void
+     * @return mixed
      */
     public static function popReader()
     {