Newsgroups: php.internals Path: news.php.net Xref: news.php.net php.internals:29031 Return-Path: Mailing-List: contact internals-help@lists.php.net; run by ezmlm Delivered-To: mailing list internals@lists.php.net Received: (qmail 41199 invoked by uid 1010); 25 Apr 2007 22:05:51 -0000 Delivered-To: ezmlm-scan-internals@lists.php.net Delivered-To: ezmlm-internals@lists.php.net Received: (qmail 41171 invoked from network); 25 Apr 2007 22:05:51 -0000 Received: from unknown (HELO lists.php.net) (127.0.0.1) by localhost with SMTP; 25 Apr 2007 22:05:51 -0000 Authentication-Results: pb1.pair.com smtp.mail=antony@zend.com; spf=pass; sender-id=pass Authentication-Results: pb1.pair.com header.from=antony@zend.com; sender-id=pass Received-SPF: pass (pb1.pair.com: domain zend.com designates 212.25.124.162 as permitted sender) X-PHP-List-Original-Sender: antony@zend.com X-Host-Fingerprint: 212.25.124.162 mail.zend.com Linux 2.5 (sometimes 2.4) (4) Received: from [212.25.124.162] ([212.25.124.162:3275] helo=mail.zend.com) by pb1.pair.com (ecelerity 2.1.1.9-wez r(12769M)) with ESMTP id 6B/04-00993-690DF264 for ; Wed, 25 Apr 2007 18:05:13 -0400 Received: (qmail 14389 invoked from network); 25 Apr 2007 22:05:06 -0000 Received: from internal.zend.office (HELO ?127.0.0.1?) (10.1.1.1) by internal.zend.office with SMTP; 25 Apr 2007 22:05:06 -0000 Message-ID: <462FD093.90402@zend.com> Date: Thu, 26 Apr 2007 02:05:07 +0400 User-Agent: Thunderbird 2.0.0.0 (X11/20070326) MIME-Version: 1.0 To: Gwynne Raskind CC: internals@lists.php.net References: <97180F0D-CB4C-4071-A859-38059C0DD1FF@wanderingknights.org> <0DFF3A59-3419-4A25-B907-E0E71FD41360@wanderingknights.org> In-Reply-To: <0DFF3A59-3419-4A25-B907-E0E71FD41360@wanderingknights.org> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Subject: Re: [PHP-DEV] Documenting the Zend2 extension API From: antony@zend.com (Antony Dovgal) 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. 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