Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:29032
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: error (pb1.pair.com: domain php.net from 85.214.94.56 cause and error)
Date: Thu, 26 Apr 2007 00:12:25 +0200
Reply-To: Marcus Boerger <helly@php.net>
Message-ID: <1168659886.20070426001225@marcus-boerger.de>
To: Antony Dovgal <antony@zend.com>
CC: Gwynne Raskind <gwynne@wanderingknights.org>, internals@lists.php.net
In-Reply-To: <462FD093.90402@zend.com>
References: <97180F0D-CB4C-4071-A859-38059C0DD1FF@wanderingknights.org> <Pine.LNX.4.62.0704252131190.1454@localhost> <0DFF3A59-3419-4A25-B907-E0E71FD41360@wanderingknights.org> <462FD093.90402@zend.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Subject: Re: [PHP-DEV] Documenting the Zend2 extension API
From: helly@php.net (Marcus Boerger)

Hello Antony,

Thursday, April 26, 2007, 12:05:07 AM, you wrote:

> On 04/26/2007 01:45 AM, Gwynne Raskind wrote:
>> Hmm... For some reason I missed that in my searches. That being said,  
>> the existence of one doesn't preclude the writing of another :).  
>> Also, it seems the official documentation in the PHP manual could use  
>> some serious updating, which I would also be willing to undertake if  
>> people think that would be more useful.

> Actually I've been recently thinking of adding some kind of documentation to the sources.
> Surely this is not supposed to be something similar to php.net/manual/, just short
> descriptions of functions and their arguments, which can be used as a start for the "real"
> documentation.
> But I wasn't lucky enough to find a utility that would fit my (personal) needs.

> Doxygen (which seems to be uses by the majority of F/OSS projects)
> generates completely unreadable docs.
> Every time I look into ICU docs (generated by Doxygen) I get lost for 10
> minutes trying to find a function _by name_.
> In the same time, other tools do not provide such a wide range of output formats as available in Doxygen.

Hu? It has a search option if you want. And it has alphabetical lists for
functions, consts, classes, files, modules, whatever. And if that is not
enough we could take it's xml output to feed a database and provide a
fulltext search on that.

> Anyways ZE internals documentation definitely needs serious update and this would be very much appreciated.
> The only problem is that you need to know the internals a bit (or at least want to learn it) to be
> able to document it, and all the people with this knowledge are busy with other things most of the time..
> You can count on me if you need any help/hints, though.

> -- 
> Wbr, 
> Antony Dovgal




Best regards,
 Marcus