Newsgroups: php.internals Path: news.php.net Xref: news.php.net php.internals:29033 Return-Path: Mailing-List: contact internals-help@lists.php.net; run by ezmlm Delivered-To: mailing list internals@lists.php.net Received: (qmail 83132 invoked by uid 1010); 25 Apr 2007 22:32:54 -0000 Delivered-To: ezmlm-scan-internals@lists.php.net Delivered-To: ezmlm-internals@lists.php.net Received: (qmail 83102 invoked from network); 25 Apr 2007 22:32:54 -0000 Received: from unknown (HELO lists.php.net) (127.0.0.1) by localhost with SMTP; 25 Apr 2007 22:32:54 -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:10299] helo=mail.zend.com) by pb1.pair.com (ecelerity 2.1.1.9-wez r(12769M)) with ESMTP id 99/18-00993-C55DF264 for ; Wed, 25 Apr 2007 18:25:35 -0400 Received: (qmail 17087 invoked from network); 25 Apr 2007 22:25:29 -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:25:29 -0000 Message-ID: <462FD55A.7080809@zend.com> Date: Thu, 26 Apr 2007 02:25:30 +0400 User-Agent: Thunderbird 2.0.0.0 (X11/20070326) MIME-Version: 1.0 To: Marcus Boerger CC: Gwynne Raskind , internals@lists.php.net References: <97180F0D-CB4C-4071-A859-38059C0DD1FF@wanderingknights.org> <0DFF3A59-3419-4A25-B907-E0E71FD41360@wanderingknights.org> <462FD093.90402@zend.com> <1168659886.20070426001225@marcus-boerger.de> In-Reply-To: <1168659886.20070426001225@marcus-boerger.de> 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 02:12 AM, Marcus Boerger wrote: >> 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. This one? =) http://www.icu-project.org/apiref/icu4c/search.php?query=strcat > And it has alphabetical lists for > functions, consts, classes, files, modules, whatever. Maybe there is something wrong with ICU docs (or with me?), but I can't find any alphabetical index of functions. All I can see is a list of functions per file, which is noway convenient. > And if that is not enough we could take it's xml output to feed a database and provide a > fulltext search on that. We can also use any of search engines available to search in the result HTML. But the point is that the docs should be well structured enough so that a fulltext search would not be required. -- Wbr, Antony Dovgal