Re: About doc-base/func(list|summary).txt
| From: | Peter Cowburn | Date: | Mon, 23 Mar 2015 09:49:42 +0000 |
| Subject: | Re: About doc-base/func(list|summary).txt | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969385515@lists.php.net to get a copy of this message | ||
On 23 March 2015 at 06:17, Maciej Sobaczewski <sobak@php.net> wrote:
> Hello,
>
> I thought it might be good to update doc-base/funclist.txt and
> doc-base/funcsummary.txt. In fact I wanted to do this out of curiosity, to
> see what has changed over the time, but I got confused.
>
For funclist.txt and funcsummary.txt, they are now generated using the
"IDE" package from PhD.
>
> I found one script generating functions list based on actual PHP sources
> and one using documentation XML sources, but result of latter differs a lot
> from current funclist.txt (there are missing entries, which should be
> present).
>
> Therefore, I have a few questions:
>
> 1) the most important one: are those files potentially or actually
> helpful? Or should I just ignore it and focus on something different (don't
> worry, I guess I've got too much time, so potiential use-case is enough for
> me)
>
> 2) is there a script which was used to generate those files or they are
> updated manually for a very long time?
>
> 3) What's preferred: to have those files generated from documentation or
> actual PHP source code? Or maybe both?
>
> I thought that generation of these two files based on XML sources should
> be fairly easy to do, so I can write one script doing both tasks, to avoid
> unnecessary duplication of code.
>
>
> Scripts I've found (as a reference):
> - doc-base/scripts/genfunclist.php - list based on php-src, grouped by
> extension, different than doc-base/funclist.txt
>
> - doc-base/scripts/genfuncsummary.php - it doesn't seem to be the one
> that generated doc-base/funcsummary.txt
>
> - doc-base/scripts/quickref/makefunclist.php - list generated from doc
> sources (just names of the files, without analyzing XML), missing some
> entries (and its output have nothing to do with doc-base/quickref.txt,
> despite the directory name, sweet)
>
> Cheers,
> Maciej.
>