Newsgroups: php.internals Path: news.php.net Xref: news.php.net php.internals:29046 Return-Path: Mailing-List: contact internals-help@lists.php.net; run by ezmlm Delivered-To: mailing list internals@lists.php.net Received: (qmail 85612 invoked by uid 1010); 26 Apr 2007 07:15:28 -0000 Delivered-To: ezmlm-scan-internals@lists.php.net Delivered-To: ezmlm-internals@lists.php.net Received: (qmail 85596 invoked from network); 26 Apr 2007 07:15:28 -0000 Received: from unknown (HELO lists.php.net) (127.0.0.1) by localhost with SMTP; 26 Apr 2007 07:15:28 -0000 Authentication-Results: pb1.pair.com header.from=derick@php.net; sender-id=unknown Authentication-Results: pb1.pair.com smtp.mail=derick@php.net; spf=permerror; sender-id=unknown Received-SPF: error (pb1.pair.com: domain php.net from 82.94.239.5 cause and error) X-PHP-List-Original-Sender: derick@php.net X-Host-Fingerprint: 82.94.239.5 jdi.jdi-ict.nl Received: from [82.94.239.5] ([82.94.239.5:34717] helo=jdi.jdi-ict.nl) by pb1.pair.com (ecelerity 2.1.1.9-wez r(12769M)) with ESMTP id 34/47-00993-D8150364 for ; Thu, 26 Apr 2007 03:15:27 -0400 Received: from localhost (localhost [127.0.0.1]) by jdi.jdi-ict.nl (8.13.7/8.12.11) with ESMTP id l3Q7FMQu009229; Thu, 26 Apr 2007 09:15:22 +0200 Date: Thu, 26 Apr 2007 09:15:08 +0200 (CEST) X-X-Sender: derick@localhost To: Marcus Boerger cc: Antony Dovgal , Gwynne Raskind , internals@lists.php.net In-Reply-To: <1168659886.20070426001225@marcus-boerger.de> Message-ID: References: <97180F0D-CB4C-4071-A859-38059C0DD1FF@wanderingknights.org> <0DFF3A59-3419-4A25-B907-E0E71FD41360@wanderingknights.org> <462FD093.90402@zend.com> <1168659886.20070426001225@marcus-boerger.de> X-Face: "L'&?Ah3MYF@FB4hU'XhNhLB]222(Lbr2Y@F:GE[OO;"F5p>qtFBl|yVVA&D{A(g3[C}mG:199P+5C'v.M/u@Z\![0b:Mv.[l6[uWl' MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Subject: Re: [PHP-DEV] Documenting the Zend2 extension API From: derick@php.net (Derick Rethans) On Thu, 26 Apr 2007, Marcus Boerger wrote: > 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. That doesn't make the docs more readable though... Derick -- Derick Rethans http://derickrethans.nl | http://ez.no | http://xdebug.org