Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:24060
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Message-ID: <7.0.1.0.2.20060609151753.03a710e0@zend.com>
Date: Fri, 09 Jun 2006 15:18:43 -0700
To: Lukas Smith <lsmith@php.net>
Cc: Steph Fox <steph@zend.com>,Nuno Lopes <nlopess@php.net>,
	Andrei Zmievski <andrei@gravitonic.com>,helly@php.net,
	Derick Rethans <derick@php.net>,internals@lists.php.net
In-Reply-To: <4489ED8D.9090000@php.net>
References: <7.0.1.0.2.20060608162444.06db8390@zend.com>
	<Pine.LNX.4.62.0606090824510.21800@localhost>
	<7.0.1.0.2.20060609065445.0371fe28@zend.com>
	<35340f912d5d4405f2da5183d804f165@gravitonic.com>
	<008d01c68bfe$1bc02890$0100a8c0@pc07653>
	<17e201c68c01$4c0d8c10$6602a8c0@foxbox>
	<7.0.1.0.2.20060609132442.03b41010@zend.com>
	<4489ED8D.9090000@php.net>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"; format=flowed
Subject: Re: [PHP-DEV] SPL docs
From: andi@zend.com (Andi Gutmans)

Yeah API docs is useful, but still we should have the end-user docs 
in the PHP manual. I don't think once comes instead of the other. The 
end-user docs is especially useful as people in the community can 
give comments, etc...

At 02:52 PM 6/9/2006, Lukas Smith wrote:
>Andi Gutmans wrote:
>>Hey,
>>I'm obviously not an expert on this stuff so I don't have much 
>>added value to add. However, I think from a high-level I think it's 
>>important that we have one PHP manual and that the manual covers 
>>both functional and oo extensions. I think the last thing we want 
>>is to have several PHP manuals.
>>My $.02. Now I'll shut up :)
>
>Well PEAR is far from being able to claim that it has solved its 
>documentation problems. However I generally think that its ok to 
>have different tools for API documentation and end user "tutorial" 
>style documentation. However I guess the main stumbling block is 
>that the PEAR API documentation is currently generated directly from 
>the source which does not really lend itself well for translations. 
>It also means that we have documentation for every single version 
>ever released. However at least I have not been good about noting 
>when features have been added. Also doxygen produces much nicer 
>inheritance graphs than what we currently have.
>
>regards,
>Lukas