Re: Re: peardoc2
| From: | (Alexander Merz) | Date: | Wed, 22 Jan 2003 19:01:30 +0000 |
| Subject: | Re: Re: peardoc2 | ||
| References: | 1 2 3 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-298@lists.php.net to get a copy of this message | ||
Alexander Merz wrote:
Thomas Schöfbeck wrote:- all subchapters of 'PECL Packages' have roman numbers while all others have normal numbers - is this intended, or a bug in the styles?The PECL section uses an other docbook structure. Until it is not clearified, how to merge phpdoc and the pecl section in peardoc, it makes no sense to thing about Typographics... ;-)is a planned system mentioned, which should create the docbook-code automatically out of the php-files (as far as I've understood ;) -> is there somewhere more info about it (Does/will it apply only for selected or all package-files, etc.)?Two Systems exists: - my PHPDoc-based pd2pm on http://www-user.tu-chemnitz.de/~meal/pd2pm-0.5.zip - and Greg Beavers pm-renderer for phpDocumentor http://phpdocu.sourceforge.net- I'd also integrate the 'make-pearweb.sh' in the makefile.inAsk martin - he is responsible for the tech stuff--with-php... has to be provided, or implement this check like in the phpdoc-group (works fine there), and document the needed bat-file.Martin...- Who is the target audience for the package-descriptions??in package.xml?If the aimed audience is the user who cares just for the interface, but not for the class-source: shouldn't this internal default VALUE be omitted, and the default BEHAVIOR described in the text? (e.g. "__global__" is only internally used, and nowhere else documented here).__global__ is offical documented by Ulf as global block name. But in general: you are right - but #2: this must decided by the Package maintainer.- Translations: My experience from phpdoc shows, that we invest MUCH more time for the maintenance of the translated files than for the transl. itself. So the question is if there would be a tool similar to phpdoc's 'revcheck' useful.Martin...