#25189 [Opn]: Function lists in the manual showing the return type.

ID: 25189 User updated by: richard dot quadling at carval dot co dot uk Reported By: richard dot quadling at carval dot co dot uk Status: Open Bug Type: Documentation problem Operating System: Any PHP Version: Irrelevant New Comment: Aha! Pretty much bang on! Thanks. Richard. Previous Comments: ------------------------------------------------------------------------ [2003-08-21 09:27:09] didou@php.net Is that what you need ? http://cvs.php.net/co.php/phpdoc/funcsummary.txt?login=2&r=1.22 didou ------------------------------------------------------------------------ [2003-08-21 09:24:12] richard dot quadling at carval dot co dot uk I suppose you are right. It is just that I would like to see the function that gives the return type I want. Often the return type and parameters suggest more about what the function does than its name. Richard. ------------------------------------------------------------------------ [2003-08-21 09:19:47] ali@php.net As it says it is the TOC which usually does not give the user detailed information about the usage of the function, but states briefly what this function does. If the function is needed for you to be used, you can just click on the link to get the doc-page of that special function which will also include the prototype-infos. In my oppinion your request would just confuse and will not lead to a more userfriendly documentation. any comments? -ali ------------------------------------------------------------------------ [2003-08-21 09:04:21] richard dot quadling at carval dot co dot uk Description: ------------ At the moment, you get this ... Table of Contents aspell_check_raw -- Check a word without changing its case or trying to trim it [deprecated] aspell_check -- Check a word [deprecated] aspell_new -- Load a new dictionary [deprecated] aspell_suggest -- Suggest spellings of a word [deprecated] When would be REALLY useful is the return types and parameters. E.g. Table of Contents bool aspell_check_raw ( int dictionary_link, string word) -- Check a word without changing its case or trying to trim it [deprecated] bool aspell_check ( int dictionary_link, string word) -- Check a word [deprecated] int aspell_new ( string master [, string personal]) -- Load a new dictionary [deprecated] array aspell_suggest ( int dictionary_link, string word) -- Suggest spellings of a word [deprecated] Why? When you are looking for a function that returns a type you can see what it may be called as sometimes the names are not what you expect. NOTE: I used aspell as an example as it only had a few entries. Regards, Richard Quadling. ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/?id=25189&edit=1