Minor glitches the PHP documentation
| From: | Gaetano Giunta | Date: | Mon, 01 Mar 2004 09:34:49 +0000 |
| Subject: | Minor glitches the PHP documentation | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969359317@lists.php.net to get a copy of this message | ||
Hello,
I am in the process of creating a tool to analyze PHP code for OS, webserver and PHP version
compatibility, minimum requirements, do some metric counts etc... (I did a quick search on Google
bot found none).
The starting point would be a PHP function and extension reference table, which I decided to create
by parsing the HTML version of the PHP documentation (Note: I just discovered today that similar
tables do exist already on the PHP site, albeit not quite up-to-date).
The extrapolation of info from HTML might sound like a dumb idea, but since I have no intention to
dig in the PHP source, it's as close to the real thing as I could find.
Wading trought the HTML documenattion for tags/specicifc tokens to base my analysis upon, I found
some inconsistencies.
You are free to judge wether these have to be fixed asap or are mere cosmetic annoyances...
- Function pdf_set_horiz_scaling misses the "Deprecated:" keyword next to the function
name in the first section (before "Description")
- Functions msql_dropdb, msql_freeresult, msql_listdbs, msql_listfields, msql_listtables,
msql_regcase and msql_selectdb miss the "Alias of xxx" description in the first section
- Function aliases definitions: most of them use "Alias of", while 7 definitions use
"Alias for" and one uses "equivalent to"
- The following functions have prototypes where one parameter is described by type but it misses a
name: dbplus_info, dbplus_next, ircg_notice, qdom_tree
- Functions that take no arguments sometimes have a (void) prototype, sometimes a () prototype
Thanks
Gaetano Giunta