Re: PEAR CS Documentation Incorrect?
| From: | Hannes Magnusson | Date: | Mon, 07 Sep 2009 19:00:14 +0000 |
| Subject: | Re: PEAR CS Documentation Incorrect? | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-52782@lists.php.net to get a copy of this message | ||
On Mon, Sep 7, 2009 at 20:18, Brandon Savage<brandon@brandonsavage.net> wrote:
> All,
>
> I was reading through the PEAR documentation today, and I noticed something
> that looked incorrect in two places.
>
> On both http://pear.php.net/manual/en/standards.header.php and
> http://pear.php.net/manual/en/standards.sample.php there is a
> code sample
> that contains the following:
>
> * @copyright 1997-2005 The PHP Group
> * @license http://www.php.net/license/3_01.txt PHP
> License 3..01
> * @version SVN: <?php
> $
> ?> Id:$
> * @link http://pear.php.net/package/PackageName
> * @see NetOther, Net_Sample::Net_Sample()
> * @since File available since Release 1.2.0
>
> I'm thinking this is incorrect, because the class is defined without
> reopening the <?php tag. Am I missing something, or is this just an error?
> Since the class is defined after this point, it wouldn't work in PHP.
As you can see by the highlighting, that example is b0rked.
I assume the documentor was trying to prevent the $Id$ keyword being
expanded by SVN.
This _could_ also be a bug in the application rendering the markup (PhD)...
Please file this as a documentation bug report :]
-Hannes