X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=scripts%2Fcheck_docs.php;h=c44eae73c33672f303a9a70b03c13347a09326c2;hp=d65effa1ed37733d3417192c4f976dfc532375d2;hb=21287ed3cfafa7f1d50ed74486288943b198006c;hpb=3837de728f09505d2bed811d0b26819ee719c3d9 diff --git a/scripts/check_docs.php b/scripts/check_docs.php index d65effa..c44eae7 100755 --- a/scripts/check_docs.php +++ b/scripts/check_docs.php @@ -4,7 +4,7 @@ function re($file, $re, &$m=NULL) { global $doc; - return preg_match($re, file_get_contents("$doc/$file"), $m); + return file_exists("$doc/$file") ? preg_match($re, file_get_contents("$doc/$file"), $m) : 0; } function fe($file) { global $doc; @@ -15,39 +15,77 @@ function fg($path, &$g=NULL) { return count($g = glob("$doc/$path")); } -$doc = "/home/mike/cvs/phpdoc/en/reference/http"; -$ext = new ReflectionExtension("http"); +$ext = "http"; +$doc = "/home/mike/Development/src/php/phpdoc/en/trunk/reference/$ext"; +$ref = new ReflectionExtension($ext); printf("Undocumented INI options:\n"); -foreach ($ext->getINIEntries() as $name => $tmp) { +foreach ($ref->getINIEntries() as $name => $tmp) { re("configuration.xml", "#$name#") or printf("\t%s (%s)\n", $name, $tmp); } printf("\n"); +printf("Undocumented stream filters:\n"); +foreach (preg_grep("/^$ext\./", stream_get_filters()) as $filter) { + fe(sprintf("streamfilters/%s.xml", substr($filter, 5))) or printf("\t%s\n", $filter); +} +printf("\n"); + printf("Undocumented constants:\n"); -foreach ($ext->getConstants() as $name => $tmp) { +foreach ($ref->getConstants() as $name => $tmp) { re("constants.xml", "#$name#") or printf("\t%s (%s)\n", $name, $tmp); } printf("\n"); printf("Undocumented functions:\n"); -foreach ($ext->getFunctions() as $func) { +foreach ($ref->getFunctions() as $func) { /* @var $func ReflectionFunction */ fg(sprintf("functions/*/%s.xml", strtr($func->getName(),'_','-'))) or printf("\t%s()\n", $func->getName()); } printf("\n"); -printf("Undocumented classes/methods:\n"); -foreach ($ext->getClasses() as $class) { +printf("Undocumented classes/members:\n"); +foreach ($ref->getClasses() as $class) { if (substr($class->getName(), -strlen("Exception")) === "Exception") continue; /* @var $class ReflectionClass */ fg(sprintf("%s.xml", $class->getName())) or printf(" %s\n", $class->getName()); + foreach ($class->getConstants() as $name => $tmp) { + re($class->getName().".xml", "#>$name<#") or printf("\t%s::%s (%s)\n", $class->getName(), $name, $tmp); + } + foreach ($class->getProperties() as $prop) { + /* @var $prop ReflectionProperty */ + $prop->isPrivate() or re($class->getName().".xml", "#>{$prop->getName()}<#") or printf("\t%s::$%s\n", $class->getName(), $prop->getName()); + } foreach ($class->getMethods() as $meth) { - fg(sprintf("%s/%s.xml", $class->getName(), strtr(trim($meth->getName(),'_'),'_','-'))) or printf("\t%s::%s()\n", $class->getName(), $meth->getName()); + /* @var $meth ReflectionMethod */ + try { + $meth->getPrototype(); + } catch (Exception $ex) { + // if getPrototype throws an exception it's definitely not a method declared in an interface + $meth->isPrivate() or fg(sprintf("%s/%s.xml", $class->getName(), strtr(trim($meth->getName(),'_'),'_','-'))) or printf("\t%s%s::%s()\n", $meth->isStatic()?'static ':'', $class->getName(), $meth->getName()); + } + } printf("\n"); } printf("\n"); +printf("Undocumented request options:\n"); +if (is_file($file = dirname(__FILE__)."/../http_request_api.c")) { + if (preg_match_all("#(?:http_request_option\(request,\s*options,\s*\")(\w+)(?=\")#", file_get_contents($file), $match)) { + foreach ($match[1] as $opt) { + re("request-options.xml", "#\s*$opt#") or printf("\t%s\n", $opt); + } + printf("\n"); + printf("List of request option entities:\n"); + foreach ($match[1] as $opt) { + printf("\t%1\$s request option'>\n", $opt); + } + } +} else { + printf("\thttp_request_api.c not found\n"); +} +printf("\n"); + ?>